7.3.0 release plan

[AA-Turner]

I intend to release Sphinx 7.3.0 reasonably soon (perhaps around the 14-16th; though I'm open to arguments to delay).

Given the volume of commits since 7.2.0, it's possible that we have accidentally made breaking changes. Being said, I think I'd still prefer to do 7.3.0 now and then 8.0 as a 'clean' release just removing depreciations.

Please let me know if there are any features or bugfixes you would like to have included in the release, or any other matters.

A

cc: @sphinx-doc/developers @sphinx-doc/triagers

[AA-Turner]

Open issues:

• Mypy is currently failing on Windows with several hundred errors
• Regression: CSS file added by extension cannot be overridden by users anymore #12096
• Docutils 0.21 support

[AA-Turner]

Sphinx 7.3.0 has been released.

A

[AA-Turner]

Fixes:

• 7.3.1: Could not import extension sphinx.builders.changes: no module named tomli #12291
• 7.3.2: Sphinx 7.3.0: furo errors (The 'furo' theme inherits from 'basic-ng', which is not a loaded theme) #12292
• 7.3.3: v7.3 release breaks jupyterbook builds #12290
• 7.3.5: sphinx~=7.3.0 breaks sphinx-immaterial #12295
• 7.3.6: sphinx~=7.3.0 breaks sphinx-immaterial #12295
• 7.3.7: Sphinx >7.3.2 imports themes in env, even if not set via html_theme #12299, py_sig_re dropped without a deprecation warning #12303, get_config fails with any section that is not 'theme' or 'options' #12305

A

[picnixz]

@AA-Turner Do you think it's worth to set-up some bot job just before releasing to check whether we break any themes due to our changes? like mypy_primer? We could either run the job manually or we could run the job before releasing (and also, theme maintainers could give us some test examples to check)

[hugovk]

And perhaps the docs build could dogfood the current Sphinx:

https://github.com/sphinx-doc/sphinx/blob/master/.github/workflows/builddoc.yml

For all supported Python versions:

1. Install Sphinx from master
2. Build the Sphinx docs

Or expand step 1 to also test packaging:

1. Build wheels, install from wheel
2. Build the Sphinx docs

[trallard]

Quick chime in.
We are in the process of improving our tests and CI for PyData Sphinx Theme. Which should help us identify breaking changes/incompatibilities with Sphinx main sooner and more reliably.

I'll do my best to flag any issues we see on our end, especially as y'all plan upcoming releases if you think that would be useful on your end to reduce churn.

Some of the changes we are adding to our CI follow the pattern mentioned above by @hugovk (build and test with the build) so happy to lend a hand if needed on your end too shall you decide to test on your end for theme's breaking.

[picnixz]

Thank you @trallard and @hugovk for your suggestions. When I'm done with the thesis' manuscript, I'll come back to ask for some ideas and suggest a proposal. I'll open a separate issue at that time and will tag you along (or maybe a discussion, I'll see when the time comes).