gh-151833: List additional documentation make targets#151832
Open
Neiland85 wants to merge 1 commit into
Open
Conversation
|
All commit authors signed the Contributor License Agreement. |
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Neiland85
changed the title
StanFromIreland
left a comment
StanFromIreland
left a comment
Member
There was a problem hiding this comment.
I would suggest moving all of these to https://devguide.python.org/documentation/start-documenting/#documenting, and pointing people there. The Devguide already has more detailed build instructions for several targets, which would be of more help to contributors.
|
|
||
| * `Sphinx <https://pypi.org/project/Sphinx/>`_ | ||
| * `blurb <https://pypi.org/project/blurb/>`_ | ||
| * `python-docs-theme <https://pypi.org/project/python-docs-theme/>`_ |
Member
There was a problem hiding this comment.
We're also missing linklint here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #151833.
Doc/README.rst lists the available documentation make targets, but it did not mention
texinfo,doctest, orgettext.These targets are defined in
Doc/Makefileand are part of the documentation build tooling. This change updates the README target list so it is more complete for contributors reading the documentation build instructions.Validation performed:
make checkfromDoc/git diff --checkThis is a documentation-only change.