mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-11-02 20:30:30 -06:00
Close #8417: autodoc: :inherited-members: option now takes multiple classes
It allows to suppress inherited members of several classes on the module at once by specifying the option to `automodule` directive
This commit is contained in:
1 parent
7bdc11e87c
commit
21e3a96f09
5 files changed
+86
-4
No files matched your search
@@ -266,6 +266,10 @@ inserting them into the page source under a suitable :rst:dir:`py:module`,
|
||||
``__str__`` will be documented as in the past, but other special method
|
||||
that are not implemented in your class ``Foo``.
|
||||
|
||||
Since v5.0, it can take a comma separated list of ancestor classes. It
|
||||
allows to suppress inherited members of several classes on the module at
|
||||
once by specifying the option to :rst:dir:`automodule` directive.
|
||||
|
||||
Note: this will lead to markup errors if the inherited members come from a
|
||||
module whose docstrings are not reST formatted.
|
||||
|
||||
@@ -275,6 +279,10 @@ inserting them into the page source under a suitable :rst:dir:`py:module`,
|
||||
|
||||
It takes an ancestor class name as an argument.
|
||||
|
||||
.. versionchanged:: 5.0
|
||||
|
||||
It takes a comma separated list of ancestor class names.
|
||||
|
||||
* It's possible to override the signature for explicitly documented callable
|
||||
objects (functions, methods, classes) with the regular syntax that will
|
||||
override the signature gained from introspection::
|
||||
|
||||
Reference in new issue
Block a user