Skip to content

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

Merged
StanFromIreland merged 7 commits into
python:mainfrom
Neiland85:docs-list-missing-make-targets
Oct 22, 2026
Merged

gh-151833: List additional documentation make targets#151832
StanFromIreland merged 7 commits into
python:mainfrom
Neiland85:docs-list-missing-make-targets

Conversation

@Neiland85

@Neiland85 Neiland85 commented Jun 21, 2026 •
edited by bedevere-app Bot
Loading

Copy link
Copy Markdown
Contributor

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 •
edited
Loading

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

chatgpt-codex-connector Bot commented Jun 21, 2026

Copy link
Copy Markdown

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

@github-project-automation github-project-automation Bot moved this to Todo in Docs PRs Jun 21, 2026

This comment was marked as low quality.

Sign in to view

@Neiland85 Neiland85 changed the title Docs: list additional documentation make targets gh-151833: List additional documentation make targets Jun 21, 2026
@bedevere-app bedevere-app Bot mentioned this pull request Jun 21, 2026
Closed
StanFromIreland
StanFromIreland reviewed Jun 21, 2026
View reviewed changes

@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

Neiland85 commented Jun 23, 2026

Copy link
Copy Markdown
Contributor 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

StanFromIreland commented Jun 25, 2026

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

Neiland85 commented Sep 15, 2026

Copy link
Copy Markdown
Contributor 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

StanFromIreland commented Sep 16, 2026

Copy link
Copy Markdown
Member

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

@StanFromIreland

StanFromIreland commented Sep 17, 2026

Copy link
Copy Markdown
Member

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

@Neiland85

Neiland85 commented Sep 26, 2026

Copy link
Copy Markdown
Contributor 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 •
edited
Loading

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #35334970 | 📁 Comparing 26abdab against main (1b9fe5c)

  🔍 Preview build  

436 files changed · + 13 added · ± 422 modified · - 1 deleted

+ Added

± Modified

- Deleted

@StanFromIreland
StanFromIreland enabled auto-merge (squash) October 22, 2026 19:34
@StanFromIreland StanFromIreland added the needs backport to 3.15 bugs and security fixes label Oct 22, 2026
@StanFromIreland
StanFromIreland merged commit 1d53cdb into python:main Oct 22, 2026
36 checks passed
@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Oct 22, 2026
@miss-islington-app

miss-islington-app Bot commented Oct 22, 2026

Copy link
Copy Markdown

Thanks @Neiland85 for the PR, and @StanFromIreland for merging it 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@bedevere-app

bedevere-app Bot commented Oct 22, 2026

Copy link
Copy Markdown

GH-160331 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 bugs and security fixes label Oct 22, 2026
@StanFromIreland

StanFromIreland commented Oct 22, 2026

Copy link
Copy Markdown
Member

Merged, thanks.

StanFromIreland added a commit that referenced this pull request Oct 22, 2026
@miss-islington @Neiland85 @StanFromIreland
[3.15] gh-151833: Document all docs make targets in Doc/README.rst (
88b0f7d 
GH-151832) (#160331)

(cherry picked from commit 1d53cdb)

Co-authored-by: Neil Munoz <theia3impact@gmail.com>
Co-authored-by: Stan Ulbrych <stan@python.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@StanFromIreland StanFromIreland StanFromIreland approved these changes

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Doc README omits some documentation make targets

3 participants

@Neiland85 @StanFromIreland