Doc README omits some documentation make targets
Open
Nobody has claimed this yet.
docs
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 35.9k
- PR merge metrics
- PR metrics pending
Description
Doc/README.rst lists the available documentation make targets, but it does not mention texinfo, doctest, or gettext.
These targets are defined in Doc/Makefile, so the README target list can be updated to be more complete for contributors reading the documentation build instructions.
Linked PRs
- gh-151832
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
Compare the target list in Doc/README.rst with the targets defined in Doc/Makefile, starting with those files. Update the README to mention texinfo, doctest, and gettext, then verify that the documented list matches the available targets.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100