Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GH-125722: Use long options for Sphinx #129039

Merged
merged 1 commit into from
Jan 20, 2025
Merged

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Jan 20, 2025

Sphinx 7.3 added long options to sphinx-build, which this PR proposes using.

Hugo added these in #118397, but had to revert them in #118401 (#118403). Nine months have passed and the median PR branch will probably have Sphinx 7.3, and if not we can use the "Update Branch" button, so I think we should try to use the long options again.

A


📚 Documentation preview 📚: https://cpython-previews--129039.org.readthedocs.build/

@AA-Turner AA-Turner added docs Documentation in the Doc dir skip news needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels Jan 20, 2025
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thanks! 🎉

@hugovk hugovk merged commit 4967fa6 into python:main Jan 20, 2025
53 checks passed
@miss-islington-app
Copy link

Thanks @AA-Turner for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 20, 2025
(cherry picked from commit 4967fa6)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 20, 2025
(cherry picked from commit 4967fa6)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Jan 20, 2025

GH-129041 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jan 20, 2025
@bedevere-app
Copy link

bedevere-app bot commented Jan 20, 2025

GH-129042 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Jan 20, 2025
hugovk pushed a commit that referenced this pull request Jan 20, 2025
GH-125722: Use long options for Sphinx (GH-129039)
(cherry picked from commit 4967fa6)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
hugovk pushed a commit that referenced this pull request Jan 20, 2025
GH-125722: Use long options for Sphinx (GH-129039)
(cherry picked from commit 4967fa6)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@AA-Turner AA-Turner deleted the docs/long-options branch January 20, 2025 12:40
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this pull request Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants