1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
|
[build-system]
requires = ["flit_core>=3.12"]
build-backend = "flit_core.buildapi"
# project metadata
[project]
name = "Sphinx"
description = "Python documentation generator"
readme = "README.rst"
urls.Changelog = "https://www.sphinx-doc.org/en/master/changes.html"
urls.Code = "https://github.com/sphinx-doc/sphinx"
urls.Documentation = "https://www.sphinx-doc.org/"
urls.Download = "https://pypi.org/project/Sphinx/"
urls.Homepage = "https://www.sphinx-doc.org/"
urls."Issue tracker" = "https://github.com/sphinx-doc/sphinx/issues"
license = "BSD-2-Clause"
license-files = [
"LICENSE.rst",
]
requires-python = ">=3.12"
# Classifiers list: https://pypi.org/classifiers/
classifiers = [
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Environment :: Web Environment",
"Intended Audience :: Developers",
"Intended Audience :: Education",
"Intended Audience :: End Users/Desktop",
"Intended Audience :: Information Technology",
"Intended Audience :: Other Audience",
"Intended Audience :: Science/Research",
"Intended Audience :: System Administrators",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Programming Language :: Python :: 3.14",
"Programming Language :: Python :: 3.15",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
"Framework :: Sphinx",
"Framework :: Sphinx :: Domain",
"Framework :: Sphinx :: Extension",
"Framework :: Sphinx :: Theme",
"Topic :: Documentation",
"Topic :: Documentation :: Sphinx",
"Topic :: Education",
"Topic :: Internet :: WWW/HTTP :: Site Management",
"Topic :: Internet :: WWW/HTTP :: Site Management :: Link Checking",
"Topic :: Printing",
"Topic :: Software Development",
"Topic :: Software Development :: Documentation",
"Topic :: Text Editors :: Documentation",
"Topic :: Text Processing",
"Topic :: Text Processing :: General",
"Topic :: Text Processing :: Indexing",
"Topic :: Text Processing :: Markup",
"Topic :: Text Processing :: Markup :: HTML",
"Topic :: Text Processing :: Markup :: LaTeX",
"Topic :: Text Processing :: Markup :: Markdown",
"Topic :: Text Processing :: Markup :: reStructuredText",
"Topic :: Text Processing :: Markup :: XML",
"Topic :: Utilities",
"Typing :: Typed",
]
dependencies = [
"Jinja2>=3.1",
"Pygments>=2.17",
"docutils>=0.21,<0.23",
"snowballstemmer>=2.2",
"babel>=2.13",
"alabaster>=0.7.14",
"imagesize>=1.3",
"requests>=2.30.0",
"roman-numerals>=1.0.0",
"packaging>=23.0",
"colorama>=0.4.6; sys_platform == 'win32'",
]
dynamic = ["version"]
[[project.authors]]
name = "Adam Turner"
email = "aa-turner@users.noreply.github.com"
[[project.authors]]
name = "Georg Brandl"
email = "georg@python.org"
[project.scripts]
sphinx-build = "sphinx.cmd.build:main"
sphinx-quickstart = "sphinx.cmd.quickstart:main"
sphinx-apidoc = "sphinx.ext.apidoc:main"
sphinx-autogen = "sphinx.ext.autosummary.generate:main"
[dependency-groups]
docs = [
"sphinxcontrib-websupport",
]
lint = [
"ruff==0.14.9",
"sphinx-lint>=0.9",
]
package = [
"build",
"pypi-attestations==0.0.28",
"twine>=6.1",
]
sphinxcontrib = [
"sphinxcontrib-applehelp>=1.0.7",
"sphinxcontrib-devhelp>=1.0.6",
"sphinxcontrib-htmlhelp>=2.0.6",
"sphinxcontrib-jsmath>=1.0.1",
"sphinxcontrib-qthelp>=1.0.6",
"sphinxcontrib-serializinghtml>=1.1.9",
]
test = [
"pytest>=9.0",
"pytest-xdist[psutil]>=3.4",
"cython>=3.0", # for Cython compilation
"defusedxml>=0.7.1", # for secure XML/HTML parsing
"setuptools>=70.0", # for Cython compilation
"typing_extensions>=4.9", # for typing_extensions.Unpack
]
translations = [
"babel>=2.13",
"Jinja2>=3.1",
]
types = [
"mypy==1.19.1",
"pyrefly",
"pyright==1.1.407",
"ty",
{ include-group = "type-stubs" },
]
type-stubs = [
# align with versions used elsewhere
"types-colorama==0.4.15.20250801",
"types-defusedxml==0.7.0.20250822",
"types-docutils==0.22.3.20251115",
"types-Pillow==10.2.0.20240822",
"types-Pygments==2.19.0.20251121",
"types-requests==2.32.4.20250913",
"types-urllib3==1.26.25.14",
]
[tool.flit.module]
name = "sphinx"
[tool.flit.sdist]
include = [
"LICENSE.rst",
"AUTHORS.rst",
"CHANGES.rst",
# Documentation
"doc/",
"CODE_OF_CONDUCT.rst", # used as an include in the Documentation
"EXAMPLES.rst", # used as an include in the Documentation
# Tests
"tests/",
"tox.ini",
# Utilities
"utils/",
"babel.cfg",
]
exclude = [
"doc/_build",
]
[tool.mypy]
files = [
"doc/conf.py",
"doc/development/tutorials/examples/autodoc_intenum.py",
"doc/development/tutorials/examples/helloworld.py",
"sphinx",
"tests",
"utils",
]
exclude = [
"tests/roots",
]
python_version = "3.12"
strict = true
show_column_numbers = true
show_error_context = true
strict_equality = false
warn_return_any = false
enable_error_code = [
"type-arg",
"redundant-self",
"truthy-iterable",
"ignore-without-code",
"unused-awaitable",
]
[[tool.mypy.overrides]]
module = [
"sphinx.domains.c",
"sphinx.domains.c._ast",
"sphinx.domains.c._parser",
"sphinx.domains.c._symbol",
"sphinx.domains.cpp",
"sphinx.domains.cpp._ast",
"sphinx.domains.cpp._parser",
"sphinx.domains.cpp._symbol",
]
strict_optional = false
[[tool.mypy.overrides]]
module = [
"imagesize",
"pyximport",
"snowballstemmer",
]
ignore_missing_imports = true
[[tool.mypy.overrides]]
module = [
# tests/
"tests.test_search",
# tests/test_config
"tests.test_config.test_config",
# tests/test_directives
"tests.test_directives.test_directive_other",
# tests/test_domains
"tests.test_domains.test_domain_c",
"tests.test_domains.test_domain_cpp",
"tests.test_domains.test_domain_js",
"tests.test_domains.test_domain_py",
"tests.test_domains.test_domain_py_fields",
"tests.test_domains.test_domain_py_pyfunction",
"tests.test_domains.test_domain_py_pyobject",
"tests.test_domains.test_domain_std",
# tests/test_environment
"tests.test_environment.test_environment_toctree",
# tests/test_ext_autodoc
"tests.test_ext_autodoc.test_ext_autodoc",
"tests.test_ext_autodoc.test_ext_autodoc_mock",
# tests/test_ext_autosummary
"tests.test_ext_autosummary.test_ext_autosummary",
# tests/test_ext_intersphinx
"tests.test_ext_intersphinx.test_ext_intersphinx",
# tests/test_ext_napoleon
"tests.test_ext_napoleon.test_ext_napoleon_docstring",
# tests/test_extensions
"tests.test_extensions.test_ext_apidoc",
"tests.test_extensions.test_ext_inheritance_diagram",
# tests/test_util
"tests.test_util.test_util_inspect",
"tests.test_util.test_util_nodes",
"tests.test_util.test_util_typing",
]
check_untyped_defs = false
disable_error_code = [
"annotation-unchecked",
]
disallow_untyped_calls = false
disallow_untyped_defs = false
[[tool.mypy.overrides]]
module = ["tests.test_util.typing_test_data"]
ignore_errors = true
[tool.coverage.run]
branch = true
parallel = true
source = ['sphinx']
[tool.coverage.report]
exclude_lines = [
# Have to re-enable the standard pragma
'pragma: no cover',
# Don't complain if tests don't hit defensive assertion code:
'raise NotImplementedError',
# Don't complain if non-runnable code isn't run:
'if __name__ == .__main__.:',
]
ignore_errors = true
[tool.pyright]
typeCheckingMode = "strict"
include = [
"doc/conf.py",
"doc/development/tutorials/examples/autodoc_intenum.py",
"doc/development/tutorials/examples/helloworld.py",
"sphinx",
"tests",
"utils",
]
exclude = [
"tests/roots",
]
reportArgumentType = "none"
reportAssignmentType = "none"
reportAttributeAccessIssue = "none"
reportCallIssue = "none"
reportConstantRedefinition = "none"
reportGeneralTypeIssues = "none"
reportIncompatibleMethodOverride = "none"
reportIncompatibleVariableOverride = "none"
reportIndexIssue = "none"
reportInvalidTypeForm = "none"
reportMissingImports = "none"
reportMissingModuleSource = "none"
reportMissingParameterType = "none"
reportMissingTypeArgument = "none"
reportMissingTypeStubs = "none"
reportOperatorIssue = "none"
reportOptionalMemberAccess = "none"
reportOptionalSubscript = "none"
reportPossiblyUnboundVariable = "none"
reportPrivateUsage = "none"
reportRedeclaration = "none"
reportReturnType = "none"
reportUnknownArgumentType = "none"
reportUnknownLambdaType = "none"
reportUnknownMemberType = "none"
reportUnknownParameterType = "none"
reportUnknownVariableType = "none"
reportUnnecessaryComparison = "none"
reportUnnecessaryIsInstance = "none"
reportUntypedBaseClass = "none"
reportUntypedNamedTuple = "none"
reportUnusedClass = "none"
reportUnusedFunction = "none"
reportUnusedImport = "none"
reportUnusedVariable = "none"
[tool.uv]
default-groups = "all"
|
