Adam Turner
d42cfa702f
Further minor copyediting of the 'extension metadata' section
2025-01-10 01:26:17 +00:00
Adam Turner
daade2715a
Rewrite the 'extension metadata' section
2025-01-10 01:09:49 +00:00
Adam Turner
44aced1ab7
Add types and defaults to confval directives ( #13218 )
2025-01-07 03:55:27 +00:00
Adam Turner
a69d79bf67
Add .gitattributes
2025-01-06 21:55:29 +00:00
Firefly
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
Adam Turner
83bf866059
Avoid attribute indirection with `env` ( #13212 )
2025-01-05 09:10:55 +00:00
James Addison
872d270f10
linkcheck: support ignored-URIs for redirects ( #13127 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-01-05 01:20:15 +00:00
Tim Hoffmann
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
Adam Turner
e65bbb96ae
Create a new type for the current document's environment state ( #13151 )
2025-01-04 00:28:03 +00:00
Nicolas Peugnet
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
Julien Lecomte
fddbd7d151
Add new `duplicate_declaration.{c,cpp}` warning types ( #13173 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-01-03 02:48:07 +00:00
Adam Turner
ff2693242d
Run Ruff on `doc/usage/extensions/`
2025-01-02 23:59:48 +00:00
Adam Turner
b5f9ac8afc
Enable the RUF100 lint in Ruff
2025-01-02 23:49:43 +00:00
Jean-François B.
df3d94ffda
Close #13130 (LaTeX docs about index creation) ( #13139 )
2024-12-02 11:12:22 +01:00
Rubén de Celis Hernández
6a8d70a2fd
Fix incorrect reference to `--config-dir` in the documentation ( #13148 )
...
The correct argument name is ``--conf-dir``.
2024-11-22 17:03:18 +00:00
Adam Turner
58b2a94770
Set 'persist-credentials' to false
2024-11-16 18:30:17 +00:00
James Addison
c93723b803
singlehtml: deprecate the 'fix_refuris' helper function ( #13037 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-11-13 23:15:00 +00:00
Tim Hoffmann
20b53bcc1a
Add a graph illustrating the build phases to the docs ( #13108 )
2024-11-13 22:22:47 +00:00
Tim Hoffmann
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
Santos Gallegos
2320c46b9e
Document `Sphinx.set_html_assets_policy` ( #13123 )
2024-11-13 22:10:03 +00:00
Tim Hoffmann
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
Adam Turner
801c60a873
Consistently calculate the current file's directory
2024-11-03 17:28:02 +00:00
Adam Turner
a6559d496b
Use pathlib in examples
2024-11-03 17:26:39 +00:00
Rafael Fontenelle
db1a190c58
Use default locale_dirs value ( #13079 )
2024-11-02 23:47:24 +00:00
Adam Turner
116a430cac
Accept PathLike in Sphinx.add_message_catalog()
2024-10-25 22:49:51 +01:00
Rafael Fontenelle
a993a52f37
Fix locale_dirs default value in documentation ( #13052 )
2024-10-21 01:04:37 +01:00
Adam Turner
541bf7bc67
Drop support for Python 3.10 ( #13000 )
2024-10-17 20:59:41 +01:00
Adam Turner
90db3e1b89
Move Sphinx 8.1 CHANGES to doc/changes
2024-10-17 19:35:29 +01:00
Jared Dillard
5a4859a2e4
Add docs about sphinx-autobuild ( #13011 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-10-12 19:07:23 +01:00
danieleades
05679efe7b
Type-check the 'autodoc_intenum' example ( #12827 )
2024-10-12 01:14:56 +01:00
Tim Hoffmann
b6269d3790
Improve documentation for the Builder API ( #13008 )
...
Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-10-12 00:21:34 +01:00
Adam Turner
c46abc4721
Improve clarity for `master_doc and root_doc`
2024-10-12 00:16:18 +01:00
Chris Sewell
c23697aaa7
Use method colour key in the Builder API graph ( #12998 )
2024-10-11 22:51:32 +01:00
Tim Hoffmann
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
James Addison
566d1cd20f
Reword a paragraph in latex_table_style's documentation ( #12994 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-10-10 16:22:05 +01:00
Adam Turner
d135d2eba3
Mark `Builder.write()` as final ( #12767 )
2024-10-10 15:59:12 +01:00
Tim Hoffmann
6cf3f9238e
Consistently use sentence case for headings ( #12987 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-10-08 23:04:18 +01:00
Tim Hoffmann
b2d69a7f41
Make a dedicated section for cross-reference syntax in docs ( #12984 )
2024-10-07 20:14:41 +01:00
James Knight
d1c4480f2a
Allow builders to override support for linkcode references ( #12852 )
...
Signed-off-by: James Knight <james.d.knight@live.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-10-06 22:54:02 +01:00
Shahriar Heidrich
7ad2733f4d
Improve code-block/sourcecode class option docs ( #11585 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-10-06 20:36:28 +01:00
danieleades
cf8f140dd8
Shrink mypy whitelist ( #12900 )
...
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: daniel.eades <daniel.eades@seebyte.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-10-05 21:37:05 +01:00
Jared Dillard
aa39a6095d
docs: fix syntax typo in intersphinx external role example ( #12941 )
2024-10-05 20:13:03 +02:00
Hugo van Kemenade
09ab6edde5
Add CVE and CWE roles ( #11781 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-10-05 18:44:14 +01:00
Adam Turner
4c638d8289
Rename `html_last_updated_time_zone to html_last_updated_use_utc` ( #12958 )
2024-10-05 16:34:00 +01:00
Adam Turner
86531aba8e
Correct the default value for `html_last_updated_fmt`
2024-10-05 16:17:53 +01:00
Adam Turner
be52db2bb3
Support placeholders for years in copyright ( #12910 )
2024-10-04 13:52:29 +01:00
Adam Turner
dfa29f9d4a
Add a missing word
2024-10-04 10:56:48 +01:00
Adam Turner
5eb68b2bff
Remove list of cross-reference roles
2024-10-03 22:20:55 +01:00
Tim Hoffmann
4080be1e82
Improve cross-reference documentation ( #12944 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-10-03 15:58:37 +01:00
