When this option is given, all sub-classes of the classes listed as arguments to `inheritance-diagram` are included in the diagram.
This makes it possible to generate a complete inheritance tree by just listing the base class and adding `:include-subclasses:`.
This is different from specifying the module that contains this base class, as this module might include other classes that should not be part of the diagram.
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
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>
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.
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.
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>
