Skip to content

Commit d7b0231

Browse files
Merge branch 'master' into add-dark-mode-toggle
2 parents bb4b6e5 + 3dddb1c commit d7b0231

33 files changed

+1039
-727
lines changed

.github/workflows/main.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ jobs:
4141
docutils:
4242
- "0.20"
4343
- "0.21"
44+
- "0.22"
4445
# include:
4546
# # test every supported Docutils version for the latest supported Python
4647
# - python: "3.13"
@@ -93,6 +94,7 @@ jobs:
9394
docutils:
9495
- "0.20"
9596
- "0.21"
97+
- "0.22"
9698

9799
steps:
98100
- uses: actions/checkout@v4

CHANGES.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ Release 8.3.0 (in development)
44
Dependencies
55
------------
66

7+
* #13786: Support `Docutils 0.22`_. Patch by Adam Turner.
8+
9+
.. _Docutils 0.22: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-22-2026-07-29
10+
711
Incompatible changes
812
--------------------
913

doc/changes/7.3.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Dependencies
8686

8787
* #11858: Increase the minimum supported version of Alabaster to 0.7.14.
8888
Patch by Adam Turner.
89-
* #11411: Support `Docutils 0.21`_. Patch by Adam Turner.
89+
* #12267: Support `Docutils 0.21`_. Patch by Adam Turner.
9090

9191
.. _Docutils 0.21: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-21-2024-04-09
9292
* #12012: Use ``types-docutils`` instead of ``docutils-stubs``.

doc/internals/contributing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ You can also test by installing dependencies in your local environment:
205205

206206
.. code-block:: shell
207207

208-
pip install .[test]
208+
pip install . --group test
209209

210210
To run JavaScript tests, use :program:`npm`:
211211

doc/usage/extensions/math.rst

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -318,14 +318,25 @@ Sphinx but is set to automatically include it from a third-party site.
318318
This has been renamed to :confval:`mathjax2_config`.
319319
:confval:`mathjax_config` is still supported for backwards compatibility.
320320

321-
:mod:`sphinx.ext.jsmath` -- Render math via JavaScript
322-
------------------------------------------------------
321+
:mod:`sphinxcontrib.jsmath` -- Render math via JavaScript
322+
---------------------------------------------------------
323323

324-
.. module:: sphinx.ext.jsmath
324+
.. module:: sphinxcontrib.jsmath
325325
:synopsis: Render math using JavaScript via JSMath.
326326

327327
This extension works just as the MathJax extension does, but uses the older
328-
package jsMath_. It provides this config value:
328+
package jsMath_. jsMath is no longer actively developed, but it has the
329+
advantage that the size of the JavaScript package is much smaller than
330+
MathJax.
331+
332+
.. versionadded:: 0.5
333+
The :mod:`!sphinx.ext.jsmath` extension.
334+
.. versionchanged:: 2.0
335+
:mod:`!sphinx.ext.jsmath` was moved to :mod:`sphinxcontrib.jsmath`.
336+
.. versionremoved:: 4.0
337+
The alias from :mod:`!sphinx.ext.jsmath` to :mod:`sphinxcontrib.jsmath`.
338+
339+
Config value:
329340

330341
.. confval:: jsmath_path
331342
:type: :code-py:`str`
@@ -337,7 +348,7 @@ package jsMath_. It provides this config value:
337348
The path can be absolute or relative; if it is relative, it is relative to
338349
the ``_static`` directory of the built docs.
339350

340-
For example, if you put JSMath into the static path of the Sphinx docs, this
351+
For example, if you put jsMath into the static path of the Sphinx docs, this
341352
value would be ``jsMath/easy/load.js``. If you host more than one
342353
Sphinx documentation set on one server, it is advisable to install jsMath in
343354
a shared location.
@@ -347,5 +358,5 @@ package jsMath_. It provides this config value:
347358
.. _dvisvgm: https://dvisvgm.de/
348359
.. _dvisvgm FAQ: https://dvisvgm.de/FAQ
349360
.. _MathJax: https://www.mathjax.org/
350-
.. _jsMath: https://www.math.union.edu/~dpvc/jsmath/
361+
.. _jsMath: https://www.math.union.edu/~dpvc/jsMath/
351362
.. _LaTeX preview package: https://www.gnu.org/software/auctex/preview-latex.html

doc/usage/installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Run the following command::
5656
Or, if writing documentation for a Python package,
5757
place the dependencies in the `pyproject.toml file`__::
5858

59-
$ pip install .[docs]
59+
$ pip install . --group docs
6060

6161
__ https://pip.pypa.io/en/stable/reference/requirements-file-format/
6262
__ https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#dependencies-optional-dependencies

pyproject.toml

Lines changed: 4 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ dependencies = [
7676
"sphinxcontrib-serializinghtml>=1.1.9",
7777
"Jinja2>=3.1",
7878
"Pygments>=2.17",
79-
"docutils>=0.20,<0.22",
79+
"docutils>=0.20,<0.23",
8080
"snowballstemmer>=2.2",
8181
"babel>=2.13",
8282
"alabaster>=0.7.14",
@@ -88,35 +88,6 @@ dependencies = [
8888
]
8989
dynamic = ["version"]
9090

91-
[project.optional-dependencies]
92-
docs = [
93-
"sphinxcontrib-websupport",
94-
]
95-
lint = [
96-
"ruff==0.12.5",
97-
"mypy==1.17.0",
98-
"sphinx-lint>=0.9",
99-
"types-colorama==0.4.15.20240311",
100-
"types-defusedxml==0.7.0.20250708",
101-
"types-docutils==0.21.0.20250525",
102-
"types-Pillow==10.2.0.20240822",
103-
"types-Pygments==2.19.0.20250715",
104-
"types-requests==2.32.4.20250611", # align with requests
105-
"types-urllib3==1.26.25.14",
106-
"pyright==1.1.400",
107-
"pytest>=8.0",
108-
"pypi-attestations==0.0.27",
109-
"betterproto==2.0.0b6",
110-
]
111-
test = [
112-
"pytest>=8.0",
113-
"pytest-xdist[psutil]>=3.4",
114-
"defusedxml>=0.7.1", # for secure XML/HTML parsing
115-
"cython>=3.0",
116-
"setuptools>=70.0", # for Cython compilation
117-
"typing_extensions>=4.9", # for typing_extensions.Unpack
118-
]
119-
12091
[[project.authors]]
12192
name = "Adam Turner"
12293
@@ -136,7 +107,7 @@ docs = [
136107
"sphinxcontrib-websupport",
137108
]
138109
lint = [
139-
"ruff==0.12.5",
110+
"ruff==0.12.7",
140111
"sphinx-lint>=0.9",
141112
]
142113
package = [
@@ -158,14 +129,14 @@ translations = [
158129
"Jinja2>=3.1",
159130
]
160131
types = [
161-
"mypy==1.17.0",
132+
"mypy==1.17.1",
162133
"pyrefly",
163134
"pyright==1.1.400",
164135
{ include-group = "type-stubs" },
165136
]
166137
type-stubs = [
167138
# align with versions used elsewhere
168-
"types-colorama==0.4.15.20240311",
139+
"types-colorama==0.4.15.20250801",
169140
"types-defusedxml==0.7.0.20250708",
170141
"types-docutils==0.21.0.20250525",
171142
"types-Pillow==10.2.0.20240822",
@@ -247,21 +218,15 @@ ignore_missing_imports = true
247218
[[tool.mypy.overrides]]
248219
module = [
249220
# tests/
250-
"tests.test_project",
251221
"tests.test_versioning",
252222
# tests/test_builders
253223
"tests.test_builders.test_build",
254224
"tests.test_builders.test_build_html",
255225
"tests.test_builders.test_build_html_5_output",
256-
"tests.test_builders.test_build_html_assets",
257-
"tests.test_builders.test_build_html_maths",
258-
"tests.test_builders.test_build_html_toctree",
259226
"tests.test_builders.test_build_linkcheck",
260227
# tests/test_directives
261228
"tests.test_directives.test_directive_code",
262229
"tests.test_directives.test_directives_no_typesetting",
263-
# tests/test_environment
264-
"tests.test_environment.test_environment",
265230
# tests/test_extensions
266231
"tests.test_extensions.test_ext_autodoc_autoclass",
267232
"tests.test_extensions.test_ext_autosummary_imports",
@@ -270,7 +235,6 @@ module = [
270235
"tests.test_extensions.test_ext_napoleon",
271236
# tests/test_markup
272237
"tests.test_markup.test_markup",
273-
"tests.test_markup.test_parser",
274238
# tests/test_theming
275239
"tests.test_theming.test_templating",
276240
"tests.test_theming.test_theming",
@@ -329,7 +293,6 @@ check_untyped_defs = false
329293
disable_error_code = [
330294
"annotation-unchecked",
331295
]
332-
disallow_incomplete_defs = false
333296
disallow_untyped_calls = false
334297
disallow_untyped_defs = false
335298

0 commit comments

Comments
 (0)