Skip to content

Doc: Upgrade Sphinx to 8.1 #125276

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

Merged
merged 4 commits into from
Oct 10, 2024
Merged

Doc: Upgrade Sphinx to 8.1 #125276

merged 4 commits into from
Oct 10, 2024

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Oct 10, 2024

The conf.py changes mean that incremental builds should now be much better, as conf.py will no longer have changed each time Sphinx is run.

A


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

@AA-Turner AA-Turner added docs Documentation in the Doc dir skip issue skip news needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Oct 10, 2024
@AA-Turner AA-Turner requested a review from hugovk October 10, 2024 17:58
@hugovk
Copy link
Member

hugovk commented Oct 10, 2024

The conf.py changes mean that incremental builds should now be much better, as conf.py will no longer have changed each time Sphinx is run.

Before:

  • make -C Doc clean venv html - 37s
  • touch Doc/library/bisect.rst
  • make -C Doc html - 28s

After:

  • make -C Doc clean venv html - 38s
  • touch Doc/library/bisect.rst
  • make -C Doc html - 4s 🚀

Wow!

@AA-Turner AA-Turner merged commit dd0ee20 into python:main Oct 10, 2024
25 checks passed
@AA-Turner AA-Turner deleted the docs/sphinx-8.1 branch October 10, 2024 20:26
@miss-islington-app
Copy link

Thanks @AA-Turner for the PR 🌮🎉.. 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 Oct 10, 2024
(cherry picked from commit dd0ee20)

Co-authored-by: Adam Turner <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 10, 2024
(cherry picked from commit dd0ee20)

Co-authored-by: Adam Turner <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Oct 10, 2024

GH-125278 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 Oct 10, 2024
@bedevere-app
Copy link

bedevere-app bot commented Oct 10, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Oct 10, 2024
AA-Turner added a commit that referenced this pull request Oct 10, 2024
Doc: Upgrade Sphinx to 8.1 (GH-125276)
(cherry picked from commit dd0ee20)

Co-authored-by: Adam Turner <[email protected]>
AA-Turner added a commit that referenced this pull request Oct 10, 2024
Doc: Upgrade Sphinx to 8.1 (GH-125276)
(cherry picked from commit dd0ee20)

Co-authored-by: Adam Turner <[email protected]>
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 issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants