IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
21,714 Commits 2 Branches 219 Tags
fdb1b0cdad06ff45af8f82a803306f8d807bb912
Commit Graph

963 Commits

Author SHA1 Message Date
Adam Turner
fdb1b0cdad Update documentation for the `:no-search:` file-wide metadata option 2025-01-10 16:56:21 +00:00
Adam Turner
44aced1ab7 Add types and defaults to confval directives (#13218) 2025-01-07 03:55:27 +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
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
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
Jean-François B.
df3d94ffda Close #13130 (LaTeX docs about index creation) (#13139) 2024-12-02 11:12:22 +01: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
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
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
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
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
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
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
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
Adam Turner
702ba34aff Restructure `autodoc` documentation (#12932) 2024-10-01 14:15:24 +01:00
Adam Turner
45b7ebdc17 Allow using GMT in the HTML last updated format (#12907) 2024-09-22 07:55:09 +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
Wei-Hsiang (Matt) Wang
e35e7b0fbe Remove unnecessary `:func: and :meth:` parentheses (#12848) 2024-09-01 06:33:28 +01:00
Jean-François B.
9943274033 LaTeX: clarify some docs, add syntax highlighting (refactoring) (#12818) 2024-08-23 18:04:38 +02: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
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
55eddad705 Use proper Pygments lexers 2024-07-24 15:21:25 +01:00
Adam Turner
b88905b6f7 Use long options to sphinx-build in our documentation 2024-07-24 15:21:25 +01:00
Adam Turner
217f267822 Do not overwrite user-supplied data by default when copying (#12647) 2024-07-22 16:00:16 +01:00
Adam Turner
9e3f4521db Drop support for Python 3.9 (#12633) 2024-07-22 15:05:15 +01:00
Bénédikt Tran
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
Chris Sewell
dabacdf5f8 Turn `show_warning_types` on by default (#12597) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-07-20 21:07:06 +01:00
James Addison
cc08854bc2 linkcheck: Update configuration defaults for Sphinx 8.0 (#12630) 
- Links that respond with HTTP 401 (unauthorized) responses are now considered ``broken`` by default.
- Timeouts that occur when checking a link are now reported with a distinct `timeout` status code, instead of the previous ``broken``.
- The previous behaviours are still available and can be configured on an opt-in basis per-project using ``conf.py``.

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2024-07-20 20:41:22 +01:00
Adam Turner
18ac58bd53 Fix possibly-invalid HTML when a rubric node is manually created 2024-07-15 10:04:48 +01:00
Adam Turner
3456ff3ca3 Add all admonitions to `directives.rst` (#12572) 
Also improve documentation for the *versionchanged* directives.
 2024-07-15 02:26:05 +01:00
Adam Turner
0f38c9c15d Emend various spelling errors 2024-07-15 02:16:34 +01:00
Adam Turner
7b570c06a1 Standardise on a common directive for describing code snippets 2024-07-15 02:15:52 +01:00