mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
5871ce266a
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.
9 lines
101 B
ReStructuredText
9 lines
101 B
ReStructuredText
|
|
.. autosummary::
|
|
:signatures: none
|
|
:toctree:
|
|
|
|
dummy_module
|
|
underscore_module_
|
|
sphinx
|