python / python/cpython

documentation builds (even local ones) refer to https://docs.python.org/

Open
#76,435 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

build docs
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

BPO 32254
Nosy @doko42

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2017-12-08.09:41:48.353>
labels = ['build', '3.7']
title = 'documentation builds (even local ones) refer to https://docs.python.org/'
updated_at = <Date 2017-12-08.09:48:35.247>
user = 'https://github.com/doko42'

bugs.python.org fields:

activity = <Date 2017-12-08.09:48:35.247>
actor = 'doko'
assignee = 'none'
closed = False
closed_date = None
closer = None
components = ['Build']
creation = <Date 2017-12-08.09:41:48.353>
creator = 'doko'
dependencies = []
files = []
hgrepos = []
issue_num = 32254
keywords = []
message_count = 2.0
messages = ['307842', '307844']
nosy_count = 1.0
nosy_names = ['doko']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = None
url = 'https://bugs.python.org/issue32254'
versions = ['Python 2.7', 'Python 3.6', 'Python 3.7']

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing a local documentation build and tracing where its links are generated. Inspect the documentation build configuration and identify why local output refers to https://docs.python.org/; done means local documentation links no longer incorrectly point to that site.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.