Commit Graph

3864 Commits

Author SHA1 Message Date
Hugo van Kemenade
95b2cce9a0 Add a `versionremoved` directive (#11905)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-01-21 20:12:52 +00:00
pcgaustad
2ccc9d315e Give a more plausible example for a combination of tags (#11899) 2024-01-20 19:10:23 +00:00
Nicolas Peugnet
59cf4d4c35 Allow custom targets in the manpage role (#11825)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-01-17 01:09:18 +00:00
danieleades
f7fbfaa471 Enable various pydocstyle (D) rules (#11878)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2024-01-14 21:13:46 +00:00
Adam Turner
587e01177d Provide example interface for ``Scorer` 2024-01-14 04:47:44 +00:00
Adam Turner
23cef9b59a Use `https://` where possible 2024-01-14 04:18:57 +00:00
James Addison
2b47fd4b4b Update linkcheck_timeout value and documentation (#11875) 2024-01-13 17:41:28 +00:00
Alex Szatmary
bcb1825679 State that `exclude_patterns` has priority (#11872) 2024-01-12 04:28:47 +00:00
James Addison
5211c01646 Enable reporting HTTP 401 hyperlinks as broken in linkcheck (#11684)
Co-authored-by: picnixz <10796600+picnixz@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-01-09 12:33:40 +00:00
Dimitri Papadopoulos Orfanos
460a63010f Fix various spelling errors (#11735) 2024-01-04 02:37:44 +00:00
Adam Turner
259118d182 Narrow the type for configuration option 'valid_types' values 2024-01-03 21:51:39 +00:00
Adam Turner
cb9656f654 Update all GitHub Actions versions 2024-01-03 03:31:39 +00:00
Rex Yuan
23c9cb4e78 [docs] Fix Makefile target in describing-code.rst (#11428) 2023-12-30 14:48:16 +01:00
Shengyu Zhang
9c3b50b31c Avoid hard-coding 'index' for the master document in templates (#11801) 2023-12-28 07:05:14 +00:00
Hugo van Kemenade
aea69ea6af Add longer option names to `sphinx-build` (#11776)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.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>
2023-12-27 00:22:52 +00:00
Adam Turner
5730329d83 Simplify the font selection 2023-10-04 16:56:47 +01:00
Adam Turner
8878bee000 Replace the header image with a new SVG logo 2023-10-04 16:56:46 +01:00
Adam Turner
3d8b00827e Promote underline levels 2023-10-03 19:39:36 +01:00
Adam Turner
81a8870eee Note that cross-referencing syntax has moved to a new location 2023-10-03 19:39:36 +01:00
Adam Turner
6a56592b30 Move cross-referencing to a new page 2023-10-03 19:32:37 +01:00
Adam Turner
909f93c7ec Use `pyproject.toml entry points rather than setup.py` 2023-10-03 19:26:37 +01:00
Adam Turner
5d58624227 Reformat the domains lists 2023-10-02 13:10:26 +01:00
Adam Turner
f7f41e6828 Fix and standardise markup 2023-10-02 13:10:26 +01:00
Adam Turner
3dd10e47d0 Add versionadded directives 2023-10-02 13:10:26 +01:00
Adam Turner
e15fc04e53 Promote underline levels 2023-10-02 13:10:26 +01:00
Adam Turner
385a9193a7 Remove redundant labels 2023-10-02 13:10:26 +01:00
Adam Turner
607aadc660 Split out the Maths domain 2023-10-02 13:10:26 +01:00
Adam Turner
c6dd47d2c8 Split out the reStructuredText domain 2023-10-02 13:10:26 +01:00
Adam Turner
f6bafc7dad Split out the JavaScript domain 2023-10-02 13:10:25 +01:00
Adam Turner
c8b2191059 Split out the Standard domain 2023-10-02 13:10:12 +01:00
Adam Turner
de3266ab25 Split out the C++ domain 2023-10-02 13:10:12 +01:00
Adam Turner
db6cc67f1a Split out the C domain 2023-10-02 13:10:12 +01:00
Adam Turner
d491d3e04c Split out the Python domain 2023-10-02 13:10:12 +01:00
Adam Turner
05682f12a6 Restore `usage/restructuredtext/domains` 2023-10-02 13:10:11 +01:00
Adam Turner
c0e17eca40 Move the domains reference up one level 2023-10-02 13:09:38 +01:00
Adam Turner
9d1dcae373 Deprecate old-style Makefiles in sphinx-quickstart (#11693) 2023-09-21 10:25:00 +01:00
Bénédikt Tran
5fe0bd41eb Strip ANSI control codes when writing to the warnings file (#11624)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-09-21 10:01:07 +01:00
Adam Turner
b935915c57 Improve make-mode documentation (#11692) 2023-09-21 09:39:39 +01:00
Adam Turner
9298de548f Update CI configuration
- Merge LaTeX and Coverage into the main CI file
- Only run tests when a relevant file changes
- Update ``actions/checkout``
- Set ``-Werror`` only on pytest steps
- Reduce verbosity on the documentation workflow
2023-09-21 09:08:29 +01:00
Adam Turner
3ac143c8bf Enable nit-picky mode in `conf.py` 2023-09-21 09:02:58 +01:00
Adam Turner
655bd15749 Adorn top-level files with a '.rst' suffix 2023-09-14 11:08:17 +01:00
Nikita Sobolev
1bd261c3a0 Fix a typo in the `:final:` option for methods (#11670) 2023-09-14 09:50:49 +01:00
Hugo van Kemenade
359edc34fc Use the Python 3 `print()` function in the documentation (#11683) 2023-09-14 09:45:20 +01:00
Matt Wozniski
43d69755df Leverage `importlib.reload` for reloading modules (#11679)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-09-13 22:58:35 +01:00
Adam Turner
ff18318613 Add an `'include-read'` event (#11657) 2023-08-30 22:21:16 +01:00
Bénédikt Tran
76658c49a9 Fix `sphinx.ext.autodoc.preserve_defaults` (#11550)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-17 01:19:25 +00:00
Bénédikt Tran
19018f01b6 Improve SigElementFallbackTransform fallback logic. (#11311)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-15 14:25:25 +01:00
Matthias Geier
65fd5be20d Use the 'toctree-wrapper' class for the `sphinx13` theme (#11129) 2023-08-14 23:40:42 +01:00
Adam Turner
9bcf1d8bb3 Fix TCH001 (move application import into a type-checking block) 2023-08-14 00:18:13 +01:00
Adam Turner
36012b7d96 Fix TCH002 (move third-party import into a type-checking block) 2023-08-13 22:50:03 +01:00