Commit Graph

3975 Commits

Author SHA1 Message Date
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
Tim Hoffmann
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
Tim Hoffmann
647863ed55 sphinx13: Use a background for inline literals (#12943) 2024-10-02 16:42:17 +01:00
Adam Turner
341b0417d5 fixup! "lint: typecheck docs/conf.py (#12697)" (#12933) 2024-10-01 14:41:04 +01:00
Adam Turner
702ba34aff Restructure `autodoc` documentation (#12932) 2024-10-01 14:15:24 +01:00
Adam Turner
1e6067c93c Remove obsolete `cut_lines from conf.py` 2024-10-01 13:40:37 +01:00
Adam Turner
45b7ebdc17 Allow using GMT in the HTML last updated format (#12907) 2024-09-22 07:55:09 +01:00
James Addison
92f024e2bf HTML search: adjustments to type-dependent CSS classnames and defaults (#12815)
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
2024-09-18 03:40:20 +01:00
Tim Hoffmann
3b9aa9cace Format `literalinclude` directive options (#12780)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-09-18 02:55:14 +01:00
khanxmetu
56716ed514 Clearly specify `latex_engine` defaults (#12876)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-09-18 01:42:47 +01:00
Shengyu Zhang
d347149f55 Document `sphinx.domains.IndexEntry` (#12820)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-09-02 10:30:49 -05:00
Wei-Hsiang (Matt) Wang
e35e7b0fbe Remove unnecessary `:func: and :meth:` parentheses (#12848) 2024-09-01 06:33:28 +01:00
SergejKr
cb3998d7e0 Note platform support for `--jobs` (#12837)
Co-authored-by: Sergej Krylow <Sergej.Krylow@sefe.eu>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-08-31 06:41:12 +00:00
danieleades
53f8edfba4 lint: typecheck docs/conf.py (#12697) 2024-08-26 11:33:34 +02:00
Jean-François B.
bf431ed0d7 LaTeX: do not use `\small with FreeMono, but Scale=0.9` (#12822) 2024-08-25 17:07:49 +02:00
Jean-François B.
3d49941484 LaTeX: two lines lost in previous commit (docs) (#12819) 2024-08-23 18:15:40 +02:00
Jean-François B.
9943274033 LaTeX: clarify some docs, add syntax highlighting (refactoring) (#12818) 2024-08-23 18:04:38 +02:00
Frank Dana
e54982f27c Fix typo in `sphinx-autogen` documentation (#12809) 2024-08-22 10:09:13 +01:00
Jean-François B.
1c131dfffe LaTeX: make contents, topic, and sidebar separately customizable (#12704)
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
2024-08-19 20:43:47 +02:00
Jean-François B.
0504903d47 Update changes/7.4.rst to quote fix of #8807 (#12802) 2024-08-19 09:11:14 +02:00
Thomas Fanning
e0f2009346 LaTeX: Add math_numsep support to latex builder (#12652)
Co-authored-by: Jean-François B <2589111+jfbu@users.noreply.github.com>
2024-08-18 21:34:20 +02:00
Jean-François B.
4c7fe10a4b LaTeX: fix mark-up when \DUrole is used with multiple classes (#12745) 2024-08-17 20:33:15 +02:00
Adam Dangoor
cb455ddada Add per-event overloads to `Sphinx.connect()` (#12784)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-08-15 21:49:50 +01:00
Tim Hoffmann
49c3b21c60 Format directive options and add some missing ones (#12779)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-08-14 20:59:50 +01:00
Adam Turner
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
Jeremy Bowman
0cbdd98ffb Correctly support custom gettext output templates (#12645)
Co-authored-by: Jeremy Bowman <jmbowman@alum.mit.edu>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-08-11 20:34:04 +01:00
Tim Hoffmann
646a5d7482 Support type-dependent search result highlighting via CSS (#12474)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
Co-authored-by: James Addison <55152140+jayaddison@users.noreply.github.com>
2024-08-11 20:22:21 +01:00
Adam Turner
be73e64a9f Add `sphinx.util._files` (#12766) 2024-08-11 19:51:59 +01:00
nikkie
c6163ff442 Fix a typo in `extdev/testing.rst` (#12765) 2024-08-11 17:57:46 +01:00
Adam Turner
d39ba32604 Add `sphinx.util._importer` (#12762) 2024-08-11 17:24:26 +01:00
Tim Hoffmann
4cf8f7a093 Restructure documentation for the toctree directive (#12725)
Structure the options using `.. rst:directive:option::` and adapt some descriptions where suitable.

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-08-11 16:36:01 +01:00
Adam Turner
18fbced7e0 Reduce the formatter's target line length to 88 (#12757) 2024-08-11 00:19:50 +01:00
James Addison
e3238260f6 Migrate JavaScript tests from Karma to the Jasmine framework (#12754) 2024-08-10 00:18:27 +01:00
Adam Turner
f0365cda38 Add titles to version-specific changes files 2024-07-30 21:09:33 +01:00
Adam Turner
0afcd01b08 Restore a missing reference target 2024-07-30 21:09:33 +01:00
Adam Turner
add38d9862 Move Sphinx 8.0 CHANGES to a dedicated file 2024-07-30 21:09:33 +01:00
Adam Turner
0eb3e822b6 Move Sphinx 7.4 CHANGES to a dedicated file 2024-07-30 21:09:33 +01:00
Adam Turner
f3c2fcddd4 Move Sphinx 7.3 CHANGES to a dedicated file 2024-07-30 21:09:33 +01:00
Adam Turner
a5aacd01d7 Move Sphinx 7.2 CHANGES to a dedicated file 2024-07-30 21:09:33 +01:00
Adam Turner
40abc219e2 Move Sphinx 7.1 CHANGES to a dedicated file 2024-07-30 21:09:33 +01:00