Bump sphinx from 5.3.0 to 7.2.3

[dependabot]

Bumps sphinx from 5.3.0 to 7.2.3.

Release notes

Sourced from sphinx's releases.

Sphinx 7.2.3

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Sphinx 7.2.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Sphinx 7.2.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Sphinx 7.2.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Sphinx 7.1.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Sphinx 7.1.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

Sphinx 7.1.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.0.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.0.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v7.0.0rc1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v6.2.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v6.2.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v6.1.3

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v6.1.2

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v6.1.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v6.1.0

Changelog: https://www.sphinx-doc.org/en/master/changes.html

v6.0.1

Changelog: https://www.sphinx-doc.org/en/master/changes.html

... (truncated)

Changelog

Sourced from sphinx's changelog.

Release 7.2.3 (released Aug 23, 2023)

Dependencies

• #11576: Require sphinxcontrib-serializinghtml 1.1.9.

Bugs fixed

• Fix regression in autodoc.Documenter.parse_name().
• Fix regression in JSON serialisation.
• #11543: autodoc: Support positional-only parameters in classmethod methods when autodoc_preserve_defaults is True.
• Restore support string methods on path objects. This is deprecated and will be removed in Sphinx 8. Use :py:funcos.fspath to convert :py:class:~pathlib.Path objects to strings, or :py:class:~pathlib.Path's methods to work with path objects.

Release 7.2.2 (released Aug 17, 2023)

Bugs fixed

• Fix the signature of the StateMachine.insert_input() patch, for when calling with keyword arguments.
• Fixed membership testing (in) for the :py:class:str interface of the asset classes (_CascadingStyleSheet and _JavaScript), which several extensions relied upon.
• Fixed a type error in SingleFileHTMLBuilder._get_local_toctree, includehidden may be passed as a string or a boolean.
• Fix :noindex: for PyModule and JSModule.

Release 7.2.1 (released Aug 17, 2023)

Bugs fixed

• Restored the the :py:class:str interface of the asset classes (_CascadingStyleSheet and _JavaScript), which several extensions relied upon. This will be removed in Sphinx 9.
• Restored calls to Builder.add_{css,js}_file(), which several extensions relied upon.
• Restored the private API TocTree.get_toctree_ancestors(), which several extensions relied upon.

Release 7.2.0 (released Aug 17, 2023)

... (truncated)

Commits

• 2f6ea14 Bump to 7.2.3 final
• 511e407 Implement bool() for string paths
• 494de73 Implement hash() for string paths
• 2986aa1 Override special methods for string paths
• 07b87e9 Update CHANGES for 7.2.3
• 6b17dd1 Support string methods on path objects (#11619)
• a73fb59 Support positional-only parameters in classmethods (#11635)
• 02cb02c Fix invocation of python -m sphinx build
• 6183b6a Require sphinxcontrib-serializinghtml 1.1.9 or later
• 1e16f21 Fix regression in autodoc.Documenter.parse_name (#11613)
• Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

---

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

[jscook2345]

@shahzebsiddiqui Do you have a way to test your docs build without building the rest of everything else? I'd be surprised if there were no warnings from such a big change in sphinx versions.

[shahzebsiddiqui]

@shahzebsiddiqui Do you have a way to test your docs build without building the rest of everything else? I'd be surprised if there were no warnings from such a big change in sphinx versions.

I dont know if its possible to build partially. The sphinx-build command will perform the documentation build and it will build the entire source tree. The automated docs build in PR will do everything as well. To build it locally its basically

cd docs
make clean
make html

The docs build will look at the sphinx conf.py see https://github.com/buildtesters/buildtest/blob/devel/docs/conf.py which also builds the APIs. At the moment we have fail_on_warning: true in https://github.com/buildtesters/buildtest/blob/devel/.readthedocs.yaml#L8 which causes the docs to fail during warning this can be a good thing to catch warning message but also leads to an inconvenience where docs are not generated when warning message is not fixed.

[jscook2345]

Well it looks like the readthedocs job failed anyways. You may need to repin your dependencies for this new sphinx.

[shahzebsiddiqui]

Well it looks like the readthedocs job failed anyways. You may need to repin your dependencies for this new sphinx.

good point yeah dependabot doesn't have clue and just picks higher version according to the build error and also changelog https://www.sphinx-doc.org/en/master/changes.html it looks like in version 7.2.0 they dropped support for python 3.8. The python community has not officially ended support for 3.8 according to https://devguide.python.org/versions/ but they apparently did in this PR sphinx-doc/sphinx#11511.

[shahzebsiddiqui]

Will create a new PR myself

[dependabot]

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version. You can also ignore all major, minor, or patch releases for a dependency by adding an ignore condition with the desired update_types to your config file.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.

[shahzebsiddiqui]

This will now be addressed by #1606