Update sphinx requirement from <6 to <7
Updates the requirements on sphinx to permit the latest version.
Release notes
Sourced from sphinx's releases.
v6.0.0
Changelog: https://www.sphinx-doc.org/en/master/changes.html
Changelog
Sourced from sphinx's changelog.
Release 6.0.0 (released Dec 29, 2022)
Dependencies
- #10468: Drop Python 3.6 support
- #10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and Docutils 0.17 support. Patch by Adam Turner
Incompatible changes
#7405: Removed the jQuery and underscore.js JavaScript frameworks.
These frameworks are no longer be automatically injected into themes from Sphinx 6.0. If you develop a theme or extension that uses the
jQuery
,$
, or$u
global objects, you need to update your JavaScript to modern standards, or use the mitigation below.The first option is to use the sphinxcontrib.jquery_ extension, which has been developed by the Sphinx team and contributors. To use this, add
sphinxcontrib.jquery
to theextensions
list inconf.py
, or callapp.setup_extension("sphinxcontrib.jquery")
if you develop a Sphinx theme or extension.The second option is to manually ensure that the frameworks are present. To re-add jQuery and underscore.js, you will need to copy
jquery.js
andunderscore.js
fromthe Sphinx repository
_ to yourstatic
directory, and add the following to yourlayout.html
:.. code-block:: html+jinja
{%- block scripts %} {{ super() }} {%- endblock %}
.. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/
Patch by Adam Turner.
#10471, #10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See :ref:
dev-deprecated-apis
for details. Patch by Adam Turner.#10901: C Domain: Remove support for parsing pre-v3 style type directives and roles. Also remove associated configuration variables
c_allow_pre_v3
andc_warn_on_allowed_pre_v3
. Patch by Adam Turner.Features added
... (truncated)
Commits
-
5b56a23
Bump to 6.0.0 final -
f1d1e9c
Update coverage workflow for Tox 4 -
66a738c
Update coverage workflow for new configuration location -
041e5f8
Add test coverage for 'today_fmt' reference substitution (#10980) -
da25145
Remove unnecessary conditional import insphinx.ext.napoleon
(#11043) -
45a0ea9
Migrate coveragepy config into pyproject.toml (#11025) -
3ec54f1
Create apydata_sphinx_theme
section in usage examples (#11046) -
32bce8f
Copy edit the tutorial (#11049) -
9844162
Fix example usingadd_config_value
(#10937) -
bf4a626
RTD builder: add graphviz depedendency (#11040) - Additional commits viewable in compare view