Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
318 commits
Select commit Hold shift + click to select a range
d4c036a
Update JavaScript sources for language stemmers to Snowball 3.0.1 (#1…
AA-Turner May 19, 2025
4532958
Remove ``const`` from ``BaseStemmer``
AA-Turner May 19, 2025
954839a
Use the more modern English stemmer (#13574)
AA-Turner May 19, 2025
75400af
Update stemming and Snowball (#13561)
AA-Turner May 19, 2025
0eae573
Remove ``section_parents`` (#13560)
AA-Turner May 19, 2025
fb628cc
Convert stopwords to a JavaScript set (#13575)
AA-Turner May 20, 2025
d71d399
autodoc: Support ``typing_extensions.{final,overload}`` (#13509)
TeamSpen210 May 20, 2025
ee0e576
Remove mypy overrides for ``test_transforms_move_module_targets`` (#1…
adamtheturtle May 20, 2025
4dbdf80
Remove mypy overrides for ``test_util_fileutil`` (#13552)
adamtheturtle May 20, 2025
6d15153
Add tilde prefix support for the ``:py:deco:`` role (#13545)
SilverRainZ May 21, 2025
ad360fd
Fix parameter lists for two event callback functions (#13516)
vwheeler63 May 21, 2025
d742ddc
Remove mypy overrides for ``tests/test_pycode/test_pycode.py`` (#13585)
adamtheturtle May 22, 2025
4451a0a
Remove mypy overrides for ``tests/test_util/test_util.py`` (#13584)
adamtheturtle May 22, 2025
a94fcd9
Remove mypy overrides for ``tests/test_util/test_util_inventory.py`` …
adamtheturtle May 22, 2025
2992f31
Remove mypy overrides for ``tests/test_pycode/test_pycode_ast.py`` (#…
adamtheturtle May 22, 2025
1a69059
Remove mypy overrides for ``tests/test_util/test_util_display.py`` (#…
adamtheturtle May 22, 2025
2c2159f
Adopt Prettier for JavaScript formatting (#13581)
AA-Turner May 24, 2025
cffaf3d
Remove unused fixture from ``test_config_pickle_protocol`` (#13590)
adamtheturtle May 24, 2025
7957429
Add initial Pyrefly configuration file (#13579)
AA-Turner May 24, 2025
a1b9444
Bump Ruff to 0.11.11 (#13589)
dependabot[bot] May 24, 2025
1f2821e
LaTeX: add support for fontawesome6 package
jfbu Apr 24, 2025
0d7ba3b
Add .auto/ to .gitignore (Emacs AUCTeX)
jfbu May 24, 2025
036db81
CI/LaTeX: run pdflatex twice when building documents
jfbu May 24, 2025
5461707
LaTeX: render in PDF hyperlinks located inside titles
jfbu Aug 25, 2024
31e63d7
Bump types-requests to 2.32.0.20250602 (#13605)
dependabot[bot] Jun 2, 2025
55092e7
Tests: Undo patch for Python 3.14.0 alpha 7; no longer required for 3…
jayaddison Jun 2, 2025
68d5610
Tests: update LaTeX label test expectations from Docutils r10151 (#13…
jayaddison Jun 2, 2025
03c2373
Extract ``_is_typing()`` to module level
AA-Turner Jun 2, 2025
987ccb2
Prefer ``str.partition`` over ``str.split(..., maxsize=1)``
AA-Turner Jun 2, 2025
2b7e3ad
Bump Ruff to 0.11.12
AA-Turner Jun 2, 2025
6a860c8
Fix #13619 about possibly duplicated footnotes from signatures in PDF…
jfbu Jun 6, 2025
43c298b
Add ``_write_docname()`` (#13624)
AA-Turner Jun 6, 2025
77a0d66
Extract nested function definitions (#13625)
AA-Turner Jun 6, 2025
50590b1
Mark class attributes as ``ClassVar`` (#13626)
AA-Turner Jun 6, 2025
0b0c039
Deprecate remaining public ``app`` attributes (#13627)
AA-Turner Jun 7, 2025
8f18b57
Close #13597 (LaTeX table in merged cell of parent table) (#13629)
jfbu Jun 7, 2025
21c8513
Avoid ``self.app`` in transforms (#13628)
AA-Turner Jun 7, 2025
0521d83
Bump Ruff to 0.11.13 (#13622)
dependabot[bot] Jun 7, 2025
3601161
Bump types-docutils to 0.21.0.20250525 (#13630)
AA-Turner Jun 7, 2025
dc33f98
autosummary: add 'vs.' to the well-known abbreviations (#13591)
MarieSacksick Jun 7, 2025
74627b2
Use anonymous references for links with embedded URLs (#13615)
timhoffm Jun 7, 2025
25ab3d7
Document the ``autolink`` role for autosummary (#13596)
melissawm Jun 7, 2025
acdf4a8
Use an explicit tags parameter for ``global_toctree_for_doc()`` (#13631)
AA-Turner Jun 7, 2025
3044d67
Avoid self.app in builder (#13632)
AA-Turner Jun 7, 2025
5392f0f
Extract ``_read_conf_py()`` from ``Config.read()`` (#13633)
AA-Turner Jun 8, 2025
39c8125
Update ``extending_build.rst`` to match ``tutorials/example/todo.py``…
vwheeler63 Jun 8, 2025
1580f5f
Note that the ``:doc:`` role is case-sensitive (#13587)
vwheeler63 Jun 8, 2025
e4accf4
Add private reference to the registry for builders
AA-Turner Jun 8, 2025
4d86047
Deprecate ``Parser.set_application()`` (#13637)
AA-Turner Jun 9, 2025
b544cfc
Rename ``SphinxBaseReader.setup()`` to ``_setup_transforms()`` (#13638)
AA-Turner Jun 9, 2025
8eaa0ab
Stop taking ``app`` in ``create_source_parser()`` (#13639)
AA-Turner Jun 9, 2025
82736e0
LaTeX: fix #13635 (cell containing table turns row colors off)
jfbu Jun 9, 2025
dfa7254
Update CHANGES for fix of issues #13597 and #13635
jfbu Jun 9, 2025
9f5e803
LaTeX: protect the fix of #13635 against a particular configuration (…
jfbu Jun 9, 2025
97f946a
Refactor and simplify ``sphinx.io._create_publisher()`` (#13642)
AA-Turner Jun 9, 2025
58ebe2d
Avoid passing ``app`` to ``SphinxComponentRegistry._get_publisher()``…
AA-Turner Jun 10, 2025
bb5e545
Deprecate ``Parser.{config,env}`` (#13644)
AA-Turner Jun 10, 2025
a536639
Move build phase to the builder (#13645)
AA-Turner Jun 10, 2025
f1316bb
LaTeX: allow more cases of table nesting, fix #13646
jfbu Jun 10, 2025
d20d348
Fix and update CHANGES.rst
jfbu Jun 10, 2025
62198d8
LaTeX: test better if tabularcolumns colspec is tabulary-specific (#1…
jfbu Jun 10, 2025
4564486
LaTeX: clarify that latest docs addition refers to LaTeX
jfbu Jun 11, 2025
118f4a1
LaTeX: make sure tabulary is used if colspec requires it (#13653)
jfbu Jun 11, 2025
fa6f8c8
Bump types-requests to 2.32.4.20250611 (#13651)
dependabot[bot] Jun 11, 2025
40b0f80
Use ``config.verbosity`` (#13650)
AA-Turner Jun 11, 2025
a2f7b41
Test with Python 3.15 alpha releases (#13654)
AA-Turner Jun 11, 2025
6b136f9
Replace ``codecs.open()`` with ``open()`` (#13655)
AA-Turner Jun 11, 2025
e1bd9cb
Make ``_prepend_prologue()`` and ``_append_epilogue()`` private (#13658)
AA-Turner Jun 11, 2025
a1639a7
Refactor ``render_partial()`` to do less work (#13664)
AA-Turner Jun 15, 2025
0767742
Docs: clarify wording regarding default style for LaTeX tables (#13667)
jfbu Jun 15, 2025
551b842
Deprecate support for source encodings other than UTF-8 (#13666)
AA-Turner Jun 16, 2025
be6593b
Prefer ``current_document.docname`` (#13669)
AA-Turner Jun 16, 2025
616faf8
Simplify ``_publish_msgstr()`` (#13670)
AA-Turner Jun 16, 2025
2b8f6da
Make parsing more explicit in ``sphinx.testing.restructuredtext`` (#1…
AA-Turner Jun 16, 2025
97f2fb2
Add ``_get_settings()`` helper function (#13672)
AA-Turner Jun 17, 2025
88f7fa9
Add ``_parse_str_to_doctree()`` helper method (#13673)
AA-Turner Jun 18, 2025
c188e3f
Restore support for nested ``only`` nodes in toctrees (#13663)
AA-Turner Jun 18, 2025
ea53cd4
Bump Ruff to 0.12.0
AA-Turner Jun 18, 2025
114093c
Use ``_parse_str_to_doctree()`` in ``Builder.read_doc()`` (#13676)
AA-Turner Jun 19, 2025
5cf62e5
Note latin-1 encoded files in .gitattributes
AA-Turner Jun 19, 2025
9c4902f
Deprecate replacing non-decodable source bytes (#13679)
AA-Turner Jun 19, 2025
711eb2b
Remove unused publisher creation functions (#13680)
AA-Turner Jun 19, 2025
f2bf37d
Extract change detection into ``_has_doc_changed()`` function (#13681)
AA-Turner Jun 19, 2025
f1edefe
Deprecate the ``sphinx.io`` module (#13682)
AA-Turner Jun 19, 2025
c384ab9
Use Docutils translators directly in the writing phase (#13683)
AA-Turner Jun 20, 2025
b9641ae
Add a file-based cache for remote intersphinx inventories (#13684)
AA-Turner Jun 22, 2025
ca043c3
`gettext`: Ignore trailing backslashes when extracting messages (#13686)
picnixz Jun 22, 2025
bb9cf58
Update CHANGES.rst
jfbu Jun 23, 2025
5221bfc
Refresh the list of third-party domains (#13691)
AA-Turner Jun 24, 2025
7551ef5
Remove mypy overrides from ``tests.test_directives.test_directive_onl…
AA-Turner Jun 24, 2025
b19e7dc
Remove mypy overrides for ``tests/test_extensions/test_ext_imgconvert…
adamtheturtle Jun 24, 2025
3f63a14
Remove mypy overrides for ``tests/test_transforms/test_transforms_reo…
adamtheturtle Jun 24, 2025
a15c149
Bump mypy to 1.16.1 (#13674)
dependabot[bot] Jun 24, 2025
74c1686
LaTeX: improve the table column widths computed by LaTeX itself
jfbu Jun 29, 2025
bd343b2
Update CHANGES to mention fix of #11973
jfbu Jun 30, 2025
5fd1462
Update changes/5.3.rst to mention fix of #6740
jfbu Jun 30, 2025
83146f1
Update CHANGES to indicate fix of #1327
jfbu Jun 30, 2025
52c4d72
Simplify a LaTeX macro (#13710)
jfbu Jul 1, 2025
7b4164a
LaTeX: better choice for \tymax parameter (#13711)
jfbu Jul 1, 2025
8949df4
Fix intersphinx reftitle for non-numeric versions (#13737)
szkarpinski Jul 19, 2025
ca794cb
Remove mypy overrides for ``tests/test_builders/test_build_html_tocde…
adamtheturtle Jul 23, 2025
d73f02d
Bump types-defusedxml to 0.7.0.20250708 (#13719)
dependabot[bot] Jul 23, 2025
8f28285
Bump pypi-attestations to 0.0.27
AA-Turner Jul 23, 2025
56b4c50
Bump Ruff to 0.12.4
AA-Turner Jul 23, 2025
16ff1fe
Move event listeners to ``sphinx.ext.autodoc._event_listeners``
AA-Turner Jul 23, 2025
dd67c7c
Move sentinels to ``sphinx.ext.autodoc._sentinels``
AA-Turner Jul 23, 2025
193b124
Delete unused MethodDescriptorType
AA-Turner Jul 23, 2025
149fb44
Move options to ``sphinx.ext.autodoc._directive_options``
AA-Turner Jul 23, 2025
58293c2
Move documenters to ``sphinx.ext.autodoc._documenters``
AA-Turner Jul 23, 2025
912e502
Bump types-pygments to 2.19.0.20250715 (#13746)
dependabot[bot] Jul 24, 2025
7522fb6
Bump mypy to 1.17.0 (#13745)
dependabot[bot] Jul 24, 2025
fb2ec7b
Bump Ruff to 0.12.5 (#13750)
dependabot[bot] Jul 25, 2025
1adc61a
Indicate preference for follow-up commits over force pushes (#13748)
stephenfin Jul 25, 2025
b92a4ed
Merge DocstringStripSignatureMixin into DocstringSignatureMixin (#13752)
AA-Turner Jul 25, 2025
69915e1
Merge ``DecoratorDocumenter.format_args()`` into FunctionDocumenter (…
AA-Turner Jul 25, 2025
ab83202
Combine ``resolve_name()`` methods (#13754)
AA-Turner Jul 25, 2025
345f068
Merge ``DocstringSignatureMixin`` into ``Documenter`` (#13755)
AA-Turner Jul 25, 2025
aae9c45
Improve ``autodoc`` sentinels (#13756)
AA-Turner Jul 25, 2025
f82de03
Inline ``DataDocumenter`` mixin classes (#13757)
AA-Turner Jul 25, 2025
b98e1c1
Inline ``AttributeDocumenter`` mixin classes (#13758)
AA-Turner Jul 25, 2025
a7bab7e
Move options processing to ``_directive_options`` (#13759)
AA-Turner Jul 26, 2025
3d79d84
Remove mypy overrides for ``tests.test_quickstart`` (#13749)
adamtheturtle Jul 26, 2025
85a0870
Remove ``ComplainOnUnhighlighted`` (#13763)
AA-Turner Jul 26, 2025
44f0d7d
Remove mypy overrides for ``test_highlighting`` (#13761)
adamtheturtle Jul 27, 2025
e094ae3
Remove mypy overrides for ``tests/test_directives/test_directive_code…
adamtheturtle Jul 27, 2025
f25cfdd
Remove mypy overrides for ``tests/test_intl/test_locale.py`` (#13764)
adamtheturtle Jul 27, 2025
8dd3d88
Use ``<span>`` in ``desc_annotation`` for better semantic HTML (#13689)
q2mark Jul 27, 2025
cb3fbe2
Remove mypy overrides for ``tests/test_intl/test_catalogs.py`` (#13767)
adamtheturtle Jul 27, 2025
087d77c
Fix type annotation for ``make_app`` pytest fixture (#13768)
adamtheturtle Jul 27, 2025
8784a78
Remove mypy overrides for ``tests/test_util/test_util_docutils.py`` (…
adamtheturtle Jul 27, 2025
641f32a
Remove mypy overrides for ``tests/test_extensions/test_ext_todo.py`` …
adamtheturtle Jul 27, 2025
9b8dce6
Remove mypy overrides for ``tests/test_builders/test_build_warnings.p…
adamtheturtle Jul 27, 2025
00d5f48
Extract autodoc importing to module-level functions (#13773)
AA-Turner Jul 28, 2025
813bd3b
Remove mypy overrides for ``tests/test_extensions/test_ext_viewcode.p…
adamtheturtle Jul 28, 2025
1883c0d
Remove mypy overrides for ``tests.test_builders.test_build_html_numfi…
adamtheturtle Jul 28, 2025
dfe9c2c
Make ``_Sentinel`` immutable (#13782)
AA-Turner Jul 28, 2025
ead64df
Introduce a new type for documenter options (#13783)
AA-Turner Jul 29, 2025
e00e771
Test with Docutils 0.22 (#13784)
AA-Turner Jul 29, 2025
5d3bb2e
Support Docutils 0.22 (#13786)
AA-Turner Jul 29, 2025
3fd98d8
Rename ``sphinx.ext.jsmath`` to ``sphinxcontrib.jsmath`` (#13788)
timhoffm Jul 31, 2025
99d3756
Bump Ruff to 0.12.7 (#13787)
dependabot[bot] Jul 31, 2025
c780dc4
Remove mypy overrides for ``tests/test_builders/test_build_html_*.py`…
adamtheturtle Jul 31, 2025
36b0571
Enable ``disallow_incomplete_defs`` for mypy (#13793)
adamtheturtle Jul 31, 2025
8150700
Bump mypy to 1.17.1 (#13795)
dependabot[bot] Aug 1, 2025
25eb929
Bump types-colorama to 0.4.15.20250801 (#13794)
dependabot[bot] Aug 1, 2025
556a5f1
Hold properties for the documented objects in new types (#13796)
AA-Turner Aug 1, 2025
4bed65e
Combine name resolution and importing (#13797)
AA-Turner Aug 2, 2025
a1b80c7
Add ``object_name`` to ``_ItemProperties`` (#13798)
AA-Turner Aug 2, 2025
9a17e80
Remove mypy overrides for ``tests/test_markup/test_parser.py`` (#13780)
adamtheturtle Aug 2, 2025
d74e544
Remove mypy overrides for ``tests/test_project.py`` (#13791)
adamtheturtle Aug 2, 2025
ab5d43c
Remove mypy overrides for ``tests/test_environment/test_environment.p…
adamtheturtle Aug 2, 2025
7715d6f
Store object ``__module__`` for ``get_real_modname()`` (#13799)
AA-Turner Aug 2, 2025
3dddb1c
Remove project extras (optional dependencies) (#13445)
AA-Turner Aug 2, 2025
3fc1588
Prefer using attributes on ``self.props`` in Documenter classes (#13801)
AA-Turner Aug 3, 2025
df5e284
Warn on invalid module ``__all__`` during initial load (#13802)
AA-Turner Aug 3, 2025
667925d
Prefer using attributes on ``documenter.props`` (followup) (#13803)
AA-Turner Aug 3, 2025
6704752
Prefer ``props._obj`` to ``documenter.object`` (#13804)
AA-Turner Aug 3, 2025
5b3d92e
LaTeX: support for using the fontawesome7 LaTeX package (#13805)
jfbu Aug 4, 2025
5f88652
autodoc: do not add :no-index-entry: twice (#13807)
haampie Aug 4, 2025
f92316a
LaTeX: fix problems in our docs (in part inherited from #13805) (#13809)
jfbu Aug 4, 2025
fa172ea
Add ``py:class`` to ``py:data`` fallback for type alias cross-referen…
ianhi Aug 4, 2025
01af042
Add filename caption to tutorial code block (#13814)
duianto Aug 5, 2025
873ecec
Update CHANGES.rst for PR #13805 (#13815)
jfbu Aug 5, 2025
90fd2a2
LaTeX: let long ``.. confval::`` argument wrap at spaces in PDF (#13817)
jfbu Aug 6, 2025
bda34f9
LaTeX: revisit and trim visit_target() (#13616)
jfbu Aug 6, 2025
6c9e320
LaTeX: support CSS3 length units (#13657)
jfbu Aug 6, 2025
85a12e2
Define the ``code-py`` role in ``autosectionlabel.rst`` (#13819)
Ch3ri0ur Aug 7, 2025
7814844
Extract autodoc object member gathering (#13820)
AA-Turner Aug 8, 2025
aeeaeaf
Bump Ruff to 0.12.8 (#13821)
dependabot[bot] Aug 8, 2025
7988c0c
Bump actions/checkout to v5 (#13837)
dependabot[bot] Aug 14, 2025
2ce6778
Add initial Ty configuration file (#13843)
AA-Turner Aug 18, 2025
e8ab5cf
linkcheck: Fix ``linkcheck_allowed_redirects`` default sentinel (#13483)
jayaddison Aug 18, 2025
9a08711
Correct the example for the ``seealso`` directive (#13854)
ugognw Aug 27, 2025
db46f0b
Document which version first supported 'types' for ``add_config_value…
AA-Turner Sep 1, 2025
1471729
Use config value as default doctest group name (#13859)
ludovic-steinbach Sep 1, 2025
9850d5e
Bump types-defusedxml to 0.7.0.20250822 (#13849)
dependabot[bot] Sep 1, 2025
754864d
Bump types-requests to 2.32.4.20250809 (#13831)
dependabot[bot] Sep 1, 2025
719237f
Support nanobind methods in ``isattributedescriptor()`` (#13836)
VincentRouvreau Sep 1, 2025
463fae6
Bump types-pygments to 2.19.0.20250809 (#13833)
dependabot[bot] Sep 1, 2025
eaebbec
Refactor ``add_sidebars()`` into ``_get_sidebars()`` (#13863)
AA-Turner Sep 1, 2025
9a41636
Partially revert "Update stemming and Snowball (#13561)"
AA-Turner Oct 2, 2025
f265d50
Fetch Snowball stopword lists as of 2015-09-01
AA-Turner Oct 2, 2025
f4e5b29
Bump Ruff to 0.12.12
AA-Turner Oct 5, 2025
11a0ddc
Bump Ruff to 0.13.0
AA-Turner Oct 5, 2025
36a4294
Bump Ruff to 0.13.3
AA-Turner Oct 5, 2025
105fa70
Bump actions versions
AA-Turner Oct 5, 2025
56939e9
Fix test setup for directive tests with Docutils 0.22+ (#13883)
gmilde Oct 5, 2025
645bc53
Bump mypy to 1.18.2
AA-Turner Oct 5, 2025
2f9d03b
Fix TypeError in ``sphinx.ext.coverage`` logging (#13885)
omad Oct 5, 2025
10af407
Document ``sphinx build -M help`` (#13881)
mfosterw Oct 5, 2025
e929009
Update list of maintained third-party domains (#13919)
taminomara Oct 5, 2025
8dd7a23
Add warning sub-type for duplicate equation label warnings (#13929)
jdillard Oct 5, 2025
f578eed
Fix incorrect index treatment of the ``:canonical:`` option in the ``…
jbms Oct 5, 2025
42aa511
Bump pyright to 1.1.406
AA-Turner Oct 5, 2025
44a9896
Use hyphenated version directives (#13714)
stephenfin Oct 5, 2025
2b5c693
Use ``normalize_options()`` from Docutils in preference to ``set_clas…
bsipocz Oct 5, 2025
046151a
Create subpackages for related ``sphinx.ext`` tests (#13930)
AA-Turner Oct 6, 2025
5e0b3ef
Extract directive header construction from runtime introspection (#13…
AA-Turner Oct 6, 2025
f3e8999
autodoc: Avoid updating ``__annotations__`` with parent class members…
jbms Oct 6, 2025
99e5ccb
Consolidate ``add_content()`` handling (#13936)
AA-Turner Oct 7, 2025
eb99d45
Bump Ruff to 0.14.0 (#13938)
dependabot[bot] Oct 8, 2025
8923f08
Extract most docstring-related logic (#13941)
AA-Turner Oct 9, 2025
22c5356
Test with released Python 3.14
AA-Turner Oct 9, 2025
ad3f3cc
Add initial support for PEP 695 type aliases (#13508)
mmatous Oct 10, 2025
90b4008
Trim LaTeX comment, obsolete as of latest TeXLive fontawesome6 and 7 …
jfbu Oct 11, 2025
10a7a6c
Move property type annotation logic to importer (#13948)
AA-Turner Oct 12, 2025
f224e04
Consolidate ``format_args()`` (#13949)
AA-Turner Oct 12, 2025
4c89a82
Improve signature handling in autodoc (#13955)
AA-Turner Oct 16, 2025
e281d26
Merge remaining special cases into ``Documenter`` (#13959)
AA-Turner Oct 16, 2025
a8f2b96
Improve various autodoc tests (#13958)
AA-Turner Oct 16, 2025
f194178
Use a new ``_best_object_type_for_member()`` function (#13961)
AA-Turner Oct 17, 2025
c58caef
Treat ``Documenter.indent`` as a constant (#13960)
AA-Turner Oct 17, 2025
2e8cedb
Remove ``member_order`` attributes (#13962)
AA-Turner Oct 17, 2025
dcfaa98
Remove unused items in ``_documenters`` (#13963)
AA-Turner Oct 17, 2025
3dec862
Delete ``FakeDirective`` in autosummary (#13967)
AA-Turner Oct 17, 2025
a4a8acc
Extract ``_gather_members()`` (#13968)
AA-Turner Oct 17, 2025
ff3e1d2
Use ``_AutodocObjType`` more consistently (#13970)
AA-Turner Oct 19, 2025
1156555
Introduce ``_AutodocAttrGetter`` type (#13971)
AA-Turner Oct 19, 2025
b5870e6
Extract the ``_docstring_source_name()`` function (#13972)
AA-Turner Oct 19, 2025
7121e99
Use ``ModuleSpec.origin`` (#13973)
AA-Turner Oct 19, 2025
ce81838
Simplify ``Autosummary.get_items()`` (#13974)
AA-Turner Oct 19, 2025
9203f2f
Avoid using ``Documenter.name`` (#13975)
AA-Turner Oct 19, 2025
fd32eb5
Extract ``_prepare_docstrings()`` (#13977)
AA-Turner Oct 20, 2025
90192fc
Use ``_load_object_by_name()`` directly (#13978)
AA-Turner Oct 20, 2025
6083b5a
Move member merging logic from ``options`` to ``_member_finder`` (#13…
AA-Turner Oct 21, 2025
fdf5411
Remove ``DocumenterBridge`` (#13984)
AA-Turner Oct 21, 2025
465b758
Extract ``_generate_directives()`` from ``Documenter._generate()`` (#…
AA-Turner Oct 21, 2025
e347e59
Fix #13939: LaTeX: page break after admonition title (#13988)
jfbu Oct 24, 2025
7993a8b
Use more type aliases for autodoc event listeners (#14008)
AA-Turner Oct 29, 2025
de745a9
Consolidate option spec processing into ``_directive_options.py`` (#1…
AA-Turner Oct 29, 2025
48f6739
Accept a sequence of strings in ``extract_summary()`` (#14014)
AA-Turner Nov 2, 2025
54e80f7
Calculate and use the ``docstring_lines`` attribute (#14015)
AA-Turner Nov 2, 2025
bb6b79b
Inline ``_get_doc()`` into ``_get_docstring_lines()`` (#14016)
AA-Turner Nov 2, 2025
08c7ee3
Use ``parent_modname`` and ``canonical_module_name`` (#14017)
AA-Turner Nov 2, 2025
8c86bad
Remove ``env`` from autodoc interfaces (#14018)
AA-Turner Nov 3, 2025
fcc9ca0
Define and use ``TEST_ROOTS_DIR`` (#14020)
AA-Turner Nov 3, 2025
83442be
Group the type alias cross-referencing test with Python domain tests …
AA-Turner Nov 3, 2025
8ca7120
Split out ``test_ext_autodoc_typehints`` (#14027)
AA-Turner Nov 4, 2025
6127d76
Integrate autodoc event callbacks into importer (#14031)
AA-Turner Nov 4, 2025
6de23cd
Split autodoc signature utilities to a new module (#14032)
AA-Turner Nov 4, 2025
4d2bd1e
Split autodoc name parsing utilities to a new module (#14033)
AA-Turner Nov 4, 2025
796a572
Combine type comment utilities into ``_type_comments.py`` (#14034)
AA-Turner Nov 4, 2025
f7b98a0
Split autodoc loader functions to a new module (#14035)
AA-Turner Nov 4, 2025
e3175f4
Reorganise and rename ``sphinx.ext.autodoc._importer`` (#14036)
AA-Turner Nov 4, 2025
245dea0
Fix ``autodoc_type_aliases`` when appearing in PEP 604 unions (``X | …
taminomara Nov 5, 2025
9eb3d79
Add a shared utilities module for autodoc (#14037)
AA-Turner Nov 5, 2025
b9d5d2b
Reduce autodoc test duration by up to four times (#14039)
AA-Turner Nov 6, 2025
62619bd
Fix test_command_line for Python 3.15 (#14040)
AA-Turner Nov 9, 2025
5b922b4
Fix #14059 (PDF build crash with French since August 2025 LaTeX) (#14…
jfbu Nov 15, 2025
5d0ad16
Correct CHANGES entry and latex comments from #14060 (#14062)
jfbu Nov 15, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 3 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ tests/roots/test-pycode/cp_1251_coded.py dos

# Non UTF-8 encodings
tests/roots/test-pycode/cp_1251_coded.py working-tree-encoding=windows-1251
tests/roots/test-root/wrongenc.inc working-tree-encoding=latin-1
tests/roots/test-warnings/wrongenc.inc working-tree-encoding=latin-1

# Generated files
# https://github.com/github/linguist/blob/master/docs/overrides.md
Expand All @@ -62,4 +64,5 @@ tests/roots/test-pycode/cp_1251_coded.py working-tree-encoding=windows-1251

tests/js/fixtures/**/*.js generated
sphinx/search/minified-js/*.js generated
sphinx/search/_stopwords/ generated
sphinx/themes/bizstyle/static/css3-mediaqueries.js generated
8 changes: 4 additions & 4 deletions .github/workflows/builddoc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,22 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@v5
uses: actions/setup-python@v6
with:
python-version: "3"
- name: Install graphviz
run: sudo apt-get install --no-install-recommends --yes graphviz
- name: Install uv
uses: astral-sh/setup-uv@v5
uses: astral-sh/setup-uv@v6
with:
version: latest
enable-cache: false
- name: Install dependencies
run: uv pip install .[docs]
run: uv pip install . --group docs
- name: Render the documentation
run: >
sphinx-build
Expand Down
49 changes: 8 additions & 41 deletions .github/workflows/create-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,31 +27,27 @@ jobs:
attestations: write # for actions/attest
id-token: write # for actions/attest & PyPI trusted publishing
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@v5
uses: actions/setup-python@v6
with:
python-version: "3"
- name: Install uv
uses: astral-sh/setup-uv@v5
uses: astral-sh/setup-uv@v6
with:
version: latest
enable-cache: false

- name: Install build dependencies (pypa/build, twine)
run: |
uv pip install build "twine>=5.1"
# resolution fails without betterproto
uv pip install pypi-attestations==0.0.21 betterproto==2.0.0b6
run: uv pip install --group package

- name: Build distribution
run: python -m build

- name: Check distribution
run: |
twine check dist/*
run: twine check dist/*

- name: Create Sigstore attestations for built distributions
uses: actions/attest@v1
Expand Down Expand Up @@ -90,39 +86,10 @@ jobs:
name: attestation-bundles
path: /tmp/attestation-bundles/

- name: Mint PyPI API token
id: mint-token
uses: actions/github-script@v7
with:
# language=JavaScript
script: |
// retrieve the ambient OIDC token
const oidc_request_token = process.env.ACTIONS_ID_TOKEN_REQUEST_TOKEN;
const oidc_request_url = process.env.ACTIONS_ID_TOKEN_REQUEST_URL;
const oidc_resp = await fetch(`${oidc_request_url}&audience=pypi`, {
headers: {Authorization: `bearer ${oidc_request_token}`},
});
const oidc_token = (await oidc_resp.json()).value;

// exchange the OIDC token for an API token
const mint_resp = await fetch('https://pypi.org/_/oidc/github/mint-token', {
method: 'post',
body: `{"token": "${oidc_token}"}` ,
headers: {'Content-Type': 'application/json'},
});
const api_token = (await mint_resp.json()).token;

// mask the newly minted API token, so that we don't accidentally leak it
core.setSecret(api_token)
core.setOutput('api-token', api_token)

- name: Upload to PyPI
env:
TWINE_NON_INTERACTIVE: "true"
TWINE_USERNAME: "__token__"
TWINE_PASSWORD: "${{ steps.mint-token.outputs.api-token }}"
run: |
twine upload dist/* --attestations
run: twine upload dist/* --attestations

github-release:
runs-on: ubuntu-latest
Expand All @@ -132,12 +99,12 @@ jobs:
permissions:
contents: write # for softprops/action-gh-release to create GitHub release
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
persist-credentials: false
- name: Get release version
id: get_version
uses: actions/github-script@v7
uses: actions/github-script@v8
with:
script: core.setOutput('version', context.ref.replace("refs/tags/v", ""))

Expand Down
52 changes: 35 additions & 17 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
persist-credentials: false

Expand All @@ -42,84 +42,102 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@v5
uses: actions/setup-python@v6
with:
python-version: "3"
- name: Install uv
uses: astral-sh/setup-uv@v5
uses: astral-sh/setup-uv@v6
with:
version: latest
enable-cache: false
- name: Install dependencies
run: uv pip install ".[lint,test]"
run: uv pip install -r pyproject.toml --group package --group test --group types
- name: Type check with mypy
run: mypy

pyright:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@v5
uses: actions/setup-python@v6
with:
python-version: "3"
- name: Install uv
uses: astral-sh/setup-uv@v5
uses: astral-sh/setup-uv@v6
with:
version: latest
enable-cache: false
- name: Install dependencies
run: uv pip install ".[lint,test]"
run: uv pip install -r pyproject.toml --group package --group test --group types
- name: Type check with pyright
run: pyright

docs-lint:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@v5
uses: actions/setup-python@v6
with:
python-version: "3"
- name: Install uv
uses: astral-sh/setup-uv@v5
uses: astral-sh/setup-uv@v6
with:
version: latest
enable-cache: false
- name: Install dependencies
run: uv pip install --upgrade sphinx-lint
run: uv pip install --group lint
- name: Lint documentation with sphinx-lint
run: make doclinter

twine:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v5
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@v5
uses: actions/setup-python@v6
with:
python-version: "3"
- name: Install uv
uses: astral-sh/setup-uv@v5
uses: astral-sh/setup-uv@v6
with:
version: latest
enable-cache: false
- name: Install dependencies
run: uv pip install --upgrade twine build
run: uv pip install --group package
- name: Lint with twine
run: |
python -m build .
twine check dist/*

prettier:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v5
- name: Set up Node.js
uses: actions/setup-node@v5
with:
node-version: "20"
cache: "npm"
- run: >
npx [email protected]
--check
"sphinx/themes/**/*.js"
"!sphinx/themes/bizstyle/static/css3-mediaqueries*.js"
"tests/js/**/*.{js,mjs}"
"!tests/js/fixtures/**"
2 changes: 1 addition & 1 deletion .github/workflows/lock.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
issues: write
pull-requests: write
steps:
- uses: actions/github-script@v7
- uses: actions/github-script@v8
with:
retries: 3
# language=JavaScript
Expand Down
Loading