Skip to content

gh-151833: List additional documentation make targets - #151832

Open
Neiland85 wants to merge 5 commits into
python:mainfrom
Neiland85:docs-list-missing-make-targets
Open

Neiland85 wants to merge 5 commits into
python:mainfrom
Neiland85:docs-list-missing-make-targets

Conversation

@Neiland85

@Neiland85 Neiland85 commented Jun 21, 2026 •

Copy link
Copy Markdown

Closes #151833.

Doc/README.rst lists the available documentation make targets, but it did not mention texinfo, doctest, or gettext.

These targets are defined in Doc/Makefile and 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 check from Doc/
  • git diff --check

This is a documentation-only change.

Copilot AI review requested due to automatic review settings June 21, 2026 07:42
@python-cla-bot

python-cla-bot Bot commented Jun 21, 2026 •

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

CLA signed

@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jun 21, 2026
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

This comment was marked as low quality.

@Neiland85 Neiland85 changed the title Docs: list additional documentation make targets gh-151833: List additional documentation make targets Jun 21, 2026

@StanFromIreland StanFromIreland left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread Doc/README.rst
@Neiland85

Copy link
Copy Markdown
Author

Thanks for the review. I can either keep this PR scoped to Doc/README.rst and add the missing linklint target, or rework it to point readers to the Devguide if that is preferred.

@StanFromIreland

Copy link
Copy Markdown
Member

Ok, for now just add linklint and check if any other things are missing. We'll do the devguide in a later commit.

@Neiland85

Copy link
Copy Markdown
Author

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?

@StanFromIreland

Copy link
Copy Markdown
Member

See my comment above, please add it at that location.

@StanFromIreland

Copy link
Copy Markdown
Member

I'm sorry, but are my review comments in #151832 (comment) not visible?

@Neiland85

Copy link
Copy Markdown
Author

Yes, the review comments are visible. Sorry for the delay.

linklint is not a make target. I had placed it in the targets list by mistake. It is now listed with the other PyPI tools, next to Sphinx / blurb / python-docs-theme, as sphinx-linklint.

texinfo, doctest, and gettext stay in the make-target list because those targets exist in Doc/Makefile.

@read-the-docs-community

read-the-docs-community Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

Doc README omits some documentation make targets

3 participants