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,808 Commits 2 Branches 219 Tags 163 MiB
d24ffe2949
Commit Graph

21808 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Adam Turner
d24ffe2949 Improve directory handling in `app_params()` 2025-01-31 17:25:13 +00:00
Adam Turner
17b8241585 Include test roots in `pytest_report_header()` 2025-01-31 17:22:51 +00:00
Adam Turner
ad9de97a8c
Run tests on macOS in GitHub Actions (#13284) 2025-01-31 14:17:06 +00:00
Adam Turner
8e26fd7d93
Run GitHub Actions on Windows Server 2022 (#13283) 2025-01-31 14:03:39 +00:00
dependabot[bot]
9cc6881213
Bump Ruff to 0.9.4 (#13281) 2025-01-31 06:21:49 +00:00
dependabot[bot]
def8140cc6
Bump pyright to 1.1.393 (#13278) 2025-01-30 07:15:10 +00:00
Adam Turner
866881583a Shorten the `suppress_warnings` changes list 2025-01-30 01:38:35 +00:00
Tiger3018
af3bb3687c
Use warning types and sub-types in more places (#11677) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2025-01-29 19:22:44 +00:00
Chris Sewell
134bd7f1fb
Add `collapsible` option to admonition directives (#12507) 
This PR adds the `collapsible` and option to the core admonition type directives, which are propagated to the nodes, e.g.

```restructuredtext
.. admonition:: title
   :collapsible:

   content

.. note:: content
   :collapsible: closed
```

For the HTML5 writer, this replaces the outer `div` with a `details` tag, and the title `p`  with a `summary` tag (with an `open` attribute if set), e.g.

```html
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>hallo</p>
</div>
```

changes to

```html
<details class="admonition note" open="open">
<summary class="admonition-title">Note</summary>
<p>hallo</p>
</details>
```

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2025-01-29 18:06:57 +01:00
Adam Turner
4936b27996 Revert keyword-only arguments change to `token_xrefs()` 2025-01-29 15:49:55 +00:00
Adam Turner
5667050dd2
Improve the displayed signature for abstract methods (#13271) 2025-01-29 02:34:46 +00:00
Adam Turner
82e9182d43
Initial implementation of an `_Inventory` type (#13275) 2025-01-29 00:46:08 +00:00
Tim Hoffmann
5871ce266a
Add support for short signatures in autosummary (#13172) 
This introduces a new ``:signatures:`` option to ``sphinx.ext.autosummary``.
Possible values are:

"long" (*default*):
  same as the current default

"short":
  format functions and classes as ``func()`` if they do not
  have arguments and ``func(…)`` if they do have arguments.

"none":
  replaces the pre-existing ``:nosignatures:`` (which becomes deprecated)

The new functionality here is the "short" option.
This allows to distinguish properties and attributes
from functions and classes without costing a lot of space
for a long signature.
 2025-01-29 00:44:09 +00:00
Victor Wheeler
3bc10dd90f
Note that `:term:` supports custom link text (#13120) 2025-01-29 00:07:08 +00:00
Adam Turner
56e52fcdbe
Fix type error in mocking `_fetch_inventory` (#13274) 2025-01-29 00:04:46 +00:00
Adam Turner
25d4ae578b Add missing issue and PR references in CHANGES 2025-01-28 02:06:36 +00:00
Jonny Saunders
18bb8bcef5
Implement :no-index-entry: for autodoc (#12233) 
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
 2025-01-28 02:01:31 +00:00
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