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

[jayaddison]

Welcome back, @AA-Turner!

I'm on a partial break from Sphinx, but will be available to check on bugreports and to shepherd a few remaining open fixes.

The only item I'd like to ensure is in 7.3.0 is:

• linkcheck builder: add 'linkcheck_report_timeouts_as_broken' config option #12023 - making the timeout status reporting for linkcheck opt-in, to avoid unexpected behaviour differences.

There are two other items that I consider very-nice-to-have:

• [tests] JavaScript: extract searchindex.js-format test fixtures. #12102 - I really want us to have genuine search index fixtures in our JS test coverage.
• HTML Search: omit anchor reference from document titles in the search index. #12047 - a fixup for a duplicate-search-result problem; however I consider [tests] JavaScript: extract searchindex.js-format test fixtures. #12102 a blocker for it (so that it can land with corresponding accurate test coverage).

[chrisjsewell]

Heya @AA-Turner, yeh thanks I'm definitely in favor of releasing sooner rather than later 👍
(and in general releasing more often / incrementally)

I guess one thing that comes to mind is #12232 (comment); i.e. how should we be checking whether we have

1. removed any existing translations that have not yet been re-translated, and/or
2. introduced new translations that have not yet been translated?

and what do we do, if we do find this to be the case?

[jfbu]

Hello @AA-Turner I am also on a break from Sphinx. As I am not aware anyhow of any blocking LaTeX related issue do go ahead please with release, Thanks!

[jayaddison]

I'm going to add one more very-nice-to-have request: I think that #12095 -- removing some network-connectivity checks from the test suite, by allowing the test suite to run equally well online/offline -- might be helpful for downstream package distributors.

(I wasn't sure whether I'd be able to find time to track down the cause of a Windows-related bug that was blocking it before the 7.3.0 release - but have done that now)

[picnixz]

• Maybe Add CVE and CWE roles #11781 could be integrated.
• If anyone has time, I would like
  • Improve sphinx.util.inspect [part 1] #12256
  • [ ] Improve sphinx.util.typing [part 2] #12257
  • [ ] Support typing_extensions.Unpack #12258
    to be supported.
• [ ] If those 3 are included (actually, only the first two are really needed), then I could also merge autodoc: add support for python_display_short_literal #12003.
• I think [autodoc] allow undocumented attributes in __init__ to be picked up by :undoc-members: #11933 could also be merged if needed.

There are some huge PRs, namely #12219 and #12093, #12106 that I prefer delaying because they affect testing so it's better to make them land in 8.x.

[picnixz]

@AA-Turner

Mypy is currently failing on Windows with several hundred errors

Is it on your side or on CI/CD? Because I also had those kind of hundred errors because I had a conflict with docutils-stubs and types-docutils. I removed docutils-stubs and no more errors (I'd suggest having a dedicated virtual environment because of that).

[danieleades]

This is an argument for a proper package manager that manages the virtual environment for local dev

[adamtheturtle]

Hopefully Plan for docutils 0.21 release can be integrated

[wlach]

• HTML Search: omit anchor reference from document titles in the search index. #12047 - a fixup for a duplicate-search-result problem; however I consider [tests] JavaScript: extract searchindex.js-format test fixtures. #12102 a blocker for it (so that it can land with corresponding accurate test coverage).

Hope I'm not speaking out of turn, but just wanted to add a comment adding a ➕ for this, @jayaddison and I put in a lot of effort to improve the search experience over the past couple months, and it would be great if the last of these fixes got in and distributed to users. I think they're quite close to being merge-ready?

[AA-Turner]

Sphinx 7.3.0 has been released.

A