PEP 12: Add list of intersphinx mappings
Nobody has claimed this yet.
- Dominant language
- reStructuredText
- Stars
- 5k
- Forks
- 1.8k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 25
Description
PEP 12 is very helpful in writing PEPs and has a section on intersphinx. However, to know the available intersphinx mappings, one has to know where to look in the sphinx configuration.
I think it would be useful to include the list directly in PEP 12.
Alternatively, if that is considered to be at too high a risk for getting outdated, one could add an explanation on where to find it.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating PEP 12 and the Sphinx configuration referenced in the issue. Confirm where the intersphinx mappings are maintained, then update PEP 12 with the list or explain where readers can find it; done means the available mappings are discoverable without prior configuration knowledge.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100