Adam Turner
7801540c08
Support `:no-index-entry: in .. {js,py}:module::` ( #13272 )
2025-01-28 01:33:28 +00:00
Simão Afonso @ Powertools Tech
60f88cc16e
Add `ref.any` as a warning sub-type ( #12739 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-01-27 19:33:22 +00:00
Adam Turner
705c1beb16
Convert _INVALID_BUILTIN_CLASSES to use strings instead of runtime objects ( #13270 )
...
This is a more flexible approach that does not require importing several modules and types into ``sphinx.util.typing``.
2025-01-27 19:17:00 +00:00
Adam Turner
7406d4222f
Move mypy test module exclusions to per-module ignores ( #13265 )
2025-01-26 19:41:15 +00:00
Adam Turner
bde37bec27
Add the `autodoc_use_type_comments` option ( #13269 )
2025-01-26 05:47:28 +00:00
Adam Turner
44891a4eef
Update the 'Python Signatures' section
2025-01-26 04:54:34 +00:00
Adam Turner
4d4123bbce
Reference 'Python' instead of 'Python 3'
2025-01-26 04:52:46 +00:00
Adam Turner
9a8eeac865
Use granular syntax highlighting for the Napoleon extension
2025-01-26 04:45:49 +00:00
Adam Turner
0bc8b4115d
Bump to Ruff 0.9.3
2025-01-25 00:48:18 +00:00
Adam Turner
a1c77f1725
Improve wording for the `:type:`directive option warning ( #13256 )
2025-01-23 14:11:57 +00:00
Adam Turner
42f300ee83
Rename the `:nowrap and :nosignatures:` directive options ( #13264 )
...
Rename the ``:nowrap`` and ``:nosignatures:`` directive options to
``:no-wrap`` and ``:no-signatures:``, for readability.
This mirrors changes already made to `:no-index`, `:no-index-entry`,
`:no-contents-entry`, and `:no-search` in Sphinx 7.2 and 7.3.
2025-01-23 04:30:46 +00:00
Adam Turner
ca2ab35d94
Add further types to `_INVALID_BUILTIN_CLASSES` ( #13263 )
2025-01-23 03:53:25 +00:00
Adam Turner
47bff3faea
Add new `types types to _INVALID_BUILTIN_CLASSES` ( #13262 )
2025-01-23 03:35:53 +00:00
Adam Turner
ea5fc5957a
Add `pathlib types to _INVALID_BUILTIN_CLASSES` ( #13261 )
2025-01-23 03:26:35 +00:00
Adam Turner
019a6661f4
Expand mypy's `ignore_missing_imports` list
2025-01-23 01:11:19 +00:00
Adam Turner
3f13b5a323
Match type-checked files in pyright and mypy
2025-01-23 01:02:31 +00:00
Adam Turner
0a1af1faea
Expand the `disallow_untyped_defs` whitelist
2025-01-23 01:00:43 +00:00
Adam Turner
5921199189
Remove `sphinx.domains.{c,cpp}` from the no-any-generics whitelist
2025-01-23 00:48:43 +00:00
Adam Turner
2bf08d6da4
Remove `sphinx.domains` from the no-any-generics whitelist
2025-01-23 00:18:03 +00:00
Adam Turner
f071dc1b5b
Remove `sphinx.util.parallel` from the no-any-generics whitelist
2025-01-23 00:13:34 +00:00
Adam Turner
2a411dcb53
Remove `sphinx.util.logging` from the no-any-generics whitelist
2025-01-22 23:48:43 +00:00
Adam Turner
3927b9e211
Remove `sphinx.util.inspect` from the no-any-generics whitelist
2025-01-22 20:36:15 +00:00
Adam Turner
7446a883c2
Remove `sphinx.util.docutils` from the no-any-generics whitelist
2025-01-22 20:29:32 +00:00
Adam Turner
705cf7fcf5
Remove `sphinx.util.docfields` from the no-any-generics whitelist
2025-01-22 20:13:44 +00:00
Adam Turner
14db5ffba1
Remove `sphinx.ext.autodoc` from the no-any-generics whitelist
2025-01-22 02:51:59 +00:00
Adam Turner
6128f2b406
Remove `sphinx.ext.inheritance_diagram` from the no-any-generics whitelist
2025-01-22 02:42:14 +00:00
Adam Turner
3258179099
Remove `sphinx.ext.graphviz` from the no-any-generics whitelist
2025-01-22 02:42:01 +00:00
Adam Turner
2d41d43ce8
Remove `sphinx.ext.doctest` from the no-any-generics whitelist
2025-01-22 02:41:47 +00:00
Adam Turner
1b607502d5
Remove top-level modules from the no-any-generics whitelist
2025-01-22 02:24:55 +00:00
Adam Turner
7154672c2e
Replace `colorize() with functions from _cli.util.colour` ( #13259 )
2025-01-21 20:38:10 +00:00
Adam Turner
df962a4b03
Remove `markupsafe._speedups` patch in free-threaded tests ( #13260 )
...
Markupsafe 3 now supports operating without the GIL.
2025-01-21 20:31:41 +00:00
Thomas Louf
1418339eb9
Allow configuration of trailing commas in multi-line signatures ( #12975 )
...
Stop outputting trailing commas for C and C++, as it is invalid syntax.
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>
Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
2025-01-21 20:08:18 +00:00
Adam Turner
fe06909e32
autodoc: Use type stub files when documenting native modules ( #13253 )
2025-01-21 19:36:55 +00:00
Adam Turner
e18155fa10
Note when `.. confval::` was added
2025-01-21 08:08:29 +00:00
Adam Turner
5b3f98ed80
Sort the `suppress_warnings` list and add missing entries
2025-01-21 08:06:19 +00:00
Adam Turner
68cbf4ee11
Add missing re-exports to `sphinx.util.console`
2025-01-21 07:00:07 +00:00
Bénédikt Tran
5b9fb9e060
autodoc: fix ordering of class and static methods for groupwise order ( #13201 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-01-20 15:19:05 +00:00
Bénédikt Tran
f4a802cce7
Add required sphinx.configuration to .readthedocs.yml ( #13255 )
2025-01-20 11:16:46 +01:00
CyrilRoelandteNovance
34037aa4ad
Allow users to suppress `autodoc.mocked_object` warnings ( #9732 )
...
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2025-01-19 23:12:40 +00:00
Adam Turner
fc62472a03
Replace `os.path.join` with pathlib ( #13252 )
2025-01-18 22:42:47 +00:00
Adam Turner
4b1d64d1e5
Use `app.build(force_all=True)`
2025-01-18 18:38:59 +00:00
Adam Turner
7227b09a2d
Replace `path with os.path`
2025-01-18 18:38:40 +00:00
Adam Turner
b005b815ae
Define `__repr__ for ENUM` ( #13251 )
2025-01-18 16:20:55 +00:00
Adam Turner
31de02cc52
Bump Ruff to 0.9.2 ( #13250 )
2025-01-18 00:35:09 +00:00
Adam Turner
e5131ba1bd
intersphinx: Create an `_InventoryItem` type ( #13248 )
2025-01-17 00:41:11 +00:00
Valentin Pratz
cfb47865d6
autosummary: Respect empty module `__all__` ( #13187 )
...
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2025-01-16 23:36:31 +00:00
Adam Turner
a0cd666906
intersphinx: Simplify domain detection in `IntersphinxRole.run()`
2025-01-16 21:49:35 +00:00
Adam Turner
f1ffe22fc9
intersphinx: Simplify `IntersphinxRole.is_existent_role()`
2025-01-16 21:49:34 +00:00
Adam Turner
4a1efef211
intersphinx: Avoid passing the full `BuildEnvironment` object
2025-01-16 21:43:47 +00:00
Adam Turner
d19eedf51d
intersphinx: Simplify to `domain_name` where possible
2025-01-16 21:40:20 +00:00
