Commit Graph

21748 Commits

Author SHA1 Message Date
Adam Turner
d1b49a12ef apidoc: Miscellaneous refactoring 2025-01-07 08:05:26 +00:00
Adam Turner
47599df1bc apidoc: Add `--automodule-options` 2025-01-07 08:05:20 +00:00
dependabot[bot]
76c4e9173e
Bump types-pygments to 2.19.0.20250107 (#13219) 2025-01-07 05:05:02 +00:00
Adam Turner
44aced1ab7
Add types and defaults to confval directives (#13218) 2025-01-07 03:55:27 +00:00
Adam Turner
9b7205b65e
Improve mathematics domain performance (#13044)
When profiling, ``MathDomain.process_doc()`` takes around 1% of runtime.
This change reduces this to ~0.
2025-01-07 01:34:18 +00:00
Adam Turner
df06e6d628
Add `InventoryFile.loads()` (#13215) 2025-01-07 00:40:57 +00:00
Adam Turner
b3035c7d22 Convert set-like containers to `frozenset` 2025-01-07 00:23:29 +00:00
Adam Turner
b852618c1b Avoid using camelCase names 2025-01-07 00:17:00 +00:00
Adam Turner
91bae649c1 Remove shebang from test-apidoc-toc test root 2025-01-06 21:55:29 +00:00
Adam Turner
a69d79bf67 Add .gitattributes 2025-01-06 21:55:29 +00:00
Adam Turner
5ff3740063 Adapt tests for Pygments 2.19 2025-01-06 06:56:10 +00:00
Adam Turner
d59084a1fa Bump Ruff to 0.8.6 2025-01-06 06:05:55 +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
ProGamerGov
fec4d7c2f1
Viewcode: Fix issue with import paths that differ from the directory structure (#13195)
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-01-05 10:43:57 +00:00
Adam Turner
83bf866059
Avoid attribute indirection with `env` (#13212) 2025-01-05 09:10:55 +00:00
Adam Turner
56c9e32fbc
Inline `sphinx_domains.lookup_domain_element` (#13211) 2025-01-05 06:57:49 +00:00
Adam Turner
531436b794 Remove redundant 'fmt: skip' comments 2025-01-05 05:42:39 +00:00
Adam Turner
0e8bff8e63 Napoleon: Use f-strings 2025-01-05 02:31:04 +00:00
Adam Turner
849d309db4 Napoleon: Use `:py:{...}` in type preprocessing 2025-01-05 02:13:15 +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
Adam Turner
182f621cad Record the change to Napoleon type preprocessing in CHANGES.rst 2025-01-05 01:18:29 +00:00
Chris Barrick
8d75ae2d6b Napoleon: Unify the type preprocessing logic
Previously, there were two type preprocessing functions:
`_convert_type_spec` (used in Google-style docstrings) and
`_convert_numpy_type_spec` (used in Numpy-style docstrings).

The Google version simply applied type-alias translations or wrapped
the text in a `:py:class:` role.

The Numpy version does the same, plus adds special handling for keywords
`optional` and `default` and delimiter words `or`, `of`, and `and`. This
allows one to write in natural language, like `Array of int` instead of
`Array[int]` or `Widget, optional` instead of `Optional[Widget]` or
`Widget | None`. Numpy style is described in full at:
https://numpydoc.readthedocs.io/en/latest/format.html#parameters

This commit eliminates the distinction and allows Google-style
docstrings to use these preprocessing rules.
2025-01-05 01:18:29 +00:00
Chris Barrick
0dbaa5b6d1 Napoleon: Move the type preprocessing code
This puts all preprocessing code above both docstring classes, rather
than in between. This is in preparation to making both docstring classes
share the same preprocessing.
2025-01-05 01:18:29 +00:00
Adam Turner
02beccac0a
intersphinx: Define a restricted subset of Config as `InvConfig` (#13210) 2025-01-05 01:06:51 +00:00
Adam Turner
619a10efa7
intersphinx: Simplify `_fetch_inventory()` (#13209)
The streams-based interfaces in intersphinx and ``sphinx.util.inventory``
are clever, but also complex and prevent using compression methods
that don't support incrememntal decoding. This change refactors
``_fetch_inventory()`` to read all inventory content from disk or an
HTTP request at once.
2025-01-05 00:34:49 +00:00
Adam Turner
e17ed74fe0 Remove unneeded content from within `with` statements 2025-01-04 09:11:33 +00:00
Adam Turner
f63784310c Use script metadata in utils/convert_attestations.py 2025-01-04 09:11:33 +00:00
Adam Turner
81832e1dc7 Use pathlib in further places 2025-01-04 09:11:33 +00:00
Maciej Olko
ad0c343d36
Trim leading whitespace before doctest flags (#13164) 2025-01-04 00:30:03 +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
Adam Turner
c7eaf175e6
linkcheck: Use pattern matching for redirected requests (#13206) 2025-01-03 23:08:02 +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
Adam Turner
20c1c7fc1c Use list literals 2025-01-03 20:56:48 +00:00
Adam Turner
546dd50c41 Use dictionary literals 2025-01-03 20:54:06 +00:00
Adam Turner
3028e818c9
Remove test skips for Python 3.14 (#13041) 2025-01-03 07:31:40 +00:00
Adam Turner
91b566de6b Split `write_temporary_file() from save_traceback()` 2025-01-03 06:45:39 +00:00
Adam Turner
2ae1d7f9c3 Split `format_traceback() from save_traceback()` 2025-01-03 06:43:06 +00:00
Adam Turner
e8f3c4902d Strip "erase entire line" control sequences in `sphinx._cli` 2025-01-03 06:39:30 +00:00
James Addison
f59f978555
Fix path resolution during 'sphinx.cmd.make_mode' cleanup (#13158) 2025-01-03 05:45:58 +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
Rafael Fontenelle
504eecada8
Remove unnecessary brackets from `meth` roles (#13193) 2025-01-03 01:41:14 +00:00
Adam Turner
00ad109a39 Run Ruff on `tests/roots/` 2025-01-03 01:33:14 +00:00
Adam Turner
b176c66f8c Enable the FURB113 lint in Ruff 2025-01-03 01:13:05 +00:00
Adam Turner
ff2693242d Run Ruff on `doc/usage/extensions/` 2025-01-02 23:59:48 +00:00
Adam Turner
013dcdc3b8 Run Ruff on `tests/js/roots/` 2025-01-02 23:53:59 +00:00
Adam Turner
c123c7b914 Remove all [format.exclude] entries 2025-01-02 23:49:44 +00:00
Adam Turner
43bf986891 Enable the RET503 lint in Ruff 2025-01-02 23:49:44 +00:00
Adam Turner
2aad3a87f4 Enable the entire Q category in Ruff 2025-01-02 23:49:44 +00:00
Adam Turner
e459a65775 Enable the entire RUF category in Ruff 2025-01-02 23:49:44 +00:00