Close #4257: autodoc: Add autodoc_class_signature

Add `autodoc_class_signature` to separate the class entry and the
definition of `__init__()` method.
This commit is contained in:
Takeshi KOMIYA
2021-05-16 01:53:48 +09:00
parent 1513d50774
commit 51ae283a38
5 changed files with 116 additions and 0 deletions
+14
View File
@@ -463,6 +463,20 @@ There are also config values that you can set:
.. versionadded:: 1.4
.. confval:: autodoc_class_signature
This value selects how the signautre will be displayed for the class defined
by :rst:dir:`autoclass` directive. The possible values are:
``"mixed"``
Display the signature with the class name.
``"separated"``
Display the signature as a method.
The default is ``"mixed"``.
.. versionadded:: 4.1
.. confval:: autodoc_member_order
This value selects if automatically documented members are sorted