Jared Dillard
934d19e900
Clarify the name passed to autodoc-skip-member ( #14629 )
2026-10-23 13:19:07 -07:00
Jared Dillard
96128b83f5
Doc: explain Napoleon configuration for import aliases ( #14642 )
2026-10-22 17:10:45 -07:00
whn and Jared Dillard
ecab3746cf
Document autodoc native module stubs environment variable ( #14563 )
...
Co-authored-by: Jared Dillard <jared.dillard@gmail.com >
2026-10-21 18:02:01 -07:00
Adam Turner
9448f26ec6
Drop support for Python 3.12 ( #14762 )
2026-10-20 14:11:44 -07:00
Jonathan Dung
c1b618c559
Fix grammatical mistakes in sphinx.ext.viewcode documentation ( #14505 )
2026-06-30 18:10:10 +02:00
Tim Pillinger and Bénédikt Tran
581c0860df
Document graphviz requirement for sphinx.ext.graphviz ( #14487 )
...
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com >
2026-06-15 08:51:10 +02:00
Adam Turner
ad0497b89d
Drop support for Python 3.11 ( #14153 )
2025-12-05 22:12:06 +00:00
Adam Turner
baffcf0935
autodoc: Deprecate mapping interface for options ( #14140 )
2025-12-01 16:12:47 +00:00
Adam Turner
2502bfcaf1
autodoc: Improve type hints for events ( #14126 )
2025-11-30 04:41:39 +00:00
gerhardtgao
aef44685df
Fix formatting of 'configuration' section in `duration.rst` ( #14115 )
2025-11-29 01:26:07 +00:00
Matthias Geier and Adam Turner
483daf722d
Use Mathjax v4 by default ( #14080 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com >
2025-11-27 21:36:07 +00:00
user27182 and Adam Turner
187a2d269c
Add configuration options to the `duration` extension ( #13469 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com >
2025-11-27 03:04:13 +00:00
Adam Turner
8256092f14
Retarget to Sphinx 9.0 ( #14093 )
2025-11-25 08:00:08 +00:00
Adam Turner
4ba30e2835
Restore the legacy implementation of autodoc for compatibility ( #14091 )
2025-11-25 07:04:14 +00:00
Dimitri Papadopoulos Orfanos
994a062c5f
Fix typos found by codespell ( #13992 )
2025-11-24 23:07:38 +00:00
Randolf Scholz and Adam Turner
67762d88a2
Add `mathjax_config_file` to load MathJax configuration from a file ( #14025 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com >
2025-11-24 20:59:21 +00:00
Adam Turner
4c89a82c1d
Improve signature handling in autodoc ( #13955 )
2025-10-16 18:54:18 +01:00
ad3f3cc062
Add initial support for PEP 695 type aliases ( #13508 )
...
Signed-off-by: Martin Matous <m@matous.dev >
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com >
Co-authored-by: Jeremy Maitin-Shepard <jbms@google.com >
2025-10-10 01:41:42 +01:00
Ch3ri0ur
85a12e255a
Define the `code-py role in autosectionlabel.rst` ( #13819 )
2025-08-07 19:09:44 +01:00
Tim Hoffmann and Adam Turner
3fd98d868a
Rename `sphinx.ext.jsmath to sphinxcontrib.jsmath` ( #13788 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com >
2025-07-31 09:59:13 +01:00
Melissa Weber Mendonça and Adam Turner
25ab3d7390
Document the `autolink` role for autosummary ( #13596 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com >
2025-06-07 17:24:56 +01:00
Till Hoffmann and Adam Turner
5831b3eeaf
Add `doctest_fail_fast` option to exit after the first failed test ( #13332 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com >
2025-03-24 19:44:16 +00:00
Chris Sewell and Adam Turner
179e24252b
Add the `sphinx.ext.apidoc` extension ( #13333 )
...
A common use-case is that users simply want to point Sphinx
towards a Python module, and have it generate documentation
automatically.
This is not possible currently, without a "pre-build" step
of running the ``sphinx-autogen`` CLI.
This PR adds ``sphinx.ext.apidoc`` as a first-party extension,
to incorporate the source file generation into the Sphinx build.
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com >
2025-02-18 00:30:30 +00:00
Adam Turner and Jakob Lykke Andersen
758dc81303
Add the `intersphinx_resolve_self` option ( #13291 )
...
Co-authored-by: Jakob Lykke Andersen <Jakob@caput.dk >
2025-02-03 17:50:46 +00:00
Walter Dörwald and Adam Turner
50fb4a9dbb
Add :include-subclasses: option to sphinx.ext.inheritance_diagram ( #8159 )
...
When this option is given, all sub-classes of the classes listed as arguments to `inheritance-diagram` are included in the diagram.
This makes it possible to generate a complete inheritance tree by just listing the base class and adding `:include-subclasses:`.
This is different from specifying the module that contains this base class, as this module might include other classes that should not be part of the diagram.
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com >
2025-02-02 20:52:23 +00:00
Tim Hoffmann
5871ce266a
Add support for short signatures in autosummary ( #13172 )
...
This introduces a new ``:signatures:`` option to ``sphinx.ext.autosummary``.
Possible values are:
"long" (*default*):
same as the current default
"short":
format functions and classes as ``func()`` if they do not
have arguments and ``func(…)`` if they do have arguments.
"none":
replaces the pre-existing ``:nosignatures:`` (which becomes deprecated)
The new functionality here is the "short" option.
This allows to distinguish properties and attributes
from functions and classes without costing a lot of space
for a long signature.
2025-01-29 00:44:09 +00:00
Jonny Saunders and Adam Turner
18bb8bcef5
Implement :no-index-entry: for autodoc ( #12233 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com >
2025-01-28 02:01:31 +00:00
Adam Turner
bde37bec27
Add the `autodoc_use_type_comments` option ( #13269 )
2025-01-26 05:47:28 +00:00
Adam Turner
4d4123bbce
Reference 'Python' instead of 'Python 3'
2025-01-26 04:52:46 +00:00
Adam Turner
9a8eeac865
Use granular syntax highlighting for the Napoleon extension
2025-01-26 04:45:49 +00:00
Adam Turner
42f300ee83
Rename the `:nowrap and :nosignatures:` directive options ( #13264 )
...
Rename the ``:nowrap`` and ``:nosignatures:`` directive options to
``:no-wrap`` and ``:no-signatures:``, for readability.
This mirrors changes already made to `:no-index`, `:no-index-entry`,
`:no-contents-entry`, and `:no-search` in Sphinx 7.2 and 7.3.
2025-01-23 04:30:46 +00:00
Bénédikt Tran and Adam Turner
5b9fb9e060
autodoc: fix ordering of class and static methods for groupwise order ( #13201 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com >
2025-01-20 15:19:05 +00:00
Adam Turner
d102e62bc7
Format code blocks in docstrings
2025-01-14 12:17:46 +00:00
Adam Turner
44aced1ab7
Add types and defaults to confval directives ( #13218 )
2025-01-07 03:55:27 +00:00
Firefly and Adam Turner
717dcc531a
Napoleon: Define confval types and defaults ( #13094 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com >
2025-01-05 11:05:12 +00:00
Tim Hoffmann and Adam Turner
432bc5e50b
Add a class option to the autosummary directive ( #13144 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com >
2025-01-04 00:28:59 +00:00
Nicolas Peugnet and Adam Turner
0fbf88a59f
Allow extensions to define the keys returned by linkcode ( #11824 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com >
2025-01-03 21:28:34 +00:00
Adam Turner
ff2693242d
Run Ruff on `doc/usage/extensions/`
2025-01-02 23:59:48 +00:00
Tim Hoffmann and Adam Turner
a2db696777
Format options for doctest directives ( #13107 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com >
2024-11-13 22:20:56 +00:00
Tim Hoffmann and Adam Turner
8117bcaae8
Format autosummary options in docs ( #13106 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com >
2024-11-07 16:25:40 +00:00
Adam Turner
1266c421be
Use pathlib in `sys.path` manipulation examples
2024-11-03 22:58:19 +00:00
Tim Hoffmann and Adam Turner
283d863af1
Minor cleanup to autosectionlabel docs ( #12992 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com >
2024-10-10 16:23:54 +01:00
Jared Dillard
aa39a6095d
docs: fix syntax typo in intersphinx external role example ( #12941 )
2024-10-05 20:13:03 +02:00
Tim Hoffmann and Adam Turner
b16e196a60
Improve `autodoc` docs ( #12935 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com >
2024-10-02 23:02:48 +00:00
Adam Turner
702ba34aff
Restructure `autodoc` documentation ( #12932 )
2024-10-01 14:15:24 +01:00
Adam Turner and Jeremy Maitin-Shepard
fadb6b10cb
Stop exiting early with `--fail-on-warnings; add --exception-on-warning` ( #12743 )
...
Co-authored-by: Jeremy Maitin-Shepard <jbms@google.com >
2024-08-13 17:12:42 +01:00
Adam Turner
b88905b6f7
Use long options to sphinx-build in our documentation
2024-07-24 15:21:25 +01:00
Adam Turner
9e3f4521db
Drop support for Python 3.9 ( #12633 )
2024-07-22 15:05:15 +01:00
Bénédikt Tran and Adam Turner
aacca3064e
Remove support for the Sphinx 0.5 `intersphinx_mapping` format ( #12083 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com >
2024-07-22 12:59:59 +01:00
Adam Turner
7b570c06a1
Standardise on a common directive for describing code snippets
2024-07-15 02:15:52 +01:00
Jared Dillard
whnandJared Dillard
Adam Turner
Jonathan Dung
Tim PillingerandBénédikt Tran
gerhardtgao
Matthias GeierandAdam Turner
user27182andAdam Turner
Dimitri Papadopoulos Orfanos
Randolf ScholzandAdam Turner
Ch3ri0ur
Tim HoffmannandAdam Turner
Melissa Weber MendonçaandAdam Turner
Till HoffmannandAdam Turner
Chris SewellandAdam Turner
Walter DörwaldandAdam Turner
Jonny SaundersandAdam Turner
FireflyandAdam Turner
Nicolas PeugnetandAdam Turner
Jared Dillard