Conversation
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
StanFromIreland
left a comment
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.
|
Thanks for the review. I can either keep this PR scoped to |
|
Ok, for now just add linklint and check if any other things are missing. We'll do the devguide in a later commit. |
|
Thanks. I checked the current tree: linklint is configured as the optional linklint.ext Sphinx extension and is listed as a documentation dependency, but there is no make linklint target in Doc/Makefile. Should linklint be documented in this README despite not being a make target, or did you mean linkcheck? |
|
See my comment above, please add it at that location. |
|
I'm sorry, but are my review comments in #151832 (comment) not visible? |
|
Yes, the review comments are visible. Sorry for the delay.
|
Documentation build overview
424 files changed ·
|
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.