Sphinx默认不会为__init__(self)生成文档。我尝试过以下方法：
.. automodule:: mymodule
:members:
和
..autoclass:: MyClass
:members:
autoclass_content = 'both'
这里有三种替代方案：
To ensure that __init__() is always documented, you can use autodoc-skip-member in conf.py. Like this:
def skip(app, what, name, obj, would_skip, options):
if name == "__init__":
return False
return would_skip
def setup(app):
app.connect("autodoc-skip-member", skip)
This explicitly defines __init__ not to be skipped (which it is by default). This configuration is specified once, and it does not require any additional markup for every class in the .rst source.
The special-members option was added in Sphinx 1.1. It makes "special" members (those with names like __special__) be documented by autodoc.
Since Sphinx 1.2, this option takes arguments which makes it more useful than it was previously.
Use automethod:
.. autoclass:: MyClass
:members:
.. automethod:: __init__
This has to be added for every class (cannot be used with automodule, as pointed out in a comment to the first revision of this answer).
automodule 可以正常使用 special-members。使用 :special-members: __init__ 只记录 __init__ 方法。 - Florian Brucker你很接近了。你可以在你的conf.py文件中使用autoclass_content选项：
autoclass_content = 'both'
autoclass_content = 'both' 选项，可以记录 init 方法，但它会使自动摘要出现两次。 - Stretch__init__方法添加到文档中。 - Terseus尽管这篇文章比较旧，但对于现在查找此信息的人来说，版本1.8中还引入了另一种解决方案。根据文档，您可以在conf.py文件中的autodoc_default_options键中添加special-members关键字。
例如：
autodoc_default_options = {
'members': True,
'member-order': 'bysource',
'special-members': '__init__',
'undoc-members': True,
'exclude-members': '__weakref__'
}
autodoc-skip-member 回调函数的变体，因为我希望像 __init__()、__enter__() 和 __exit__() 这样的方法显示在我的 API 文档中（毕竟，这些“特殊方法”是 API 的一部分，最好的地方就是在特殊方法的文档字符串中记录它们）。import types
def setup(app):
"""Enable Sphinx customizations."""
enable_special_methods(app)
def enable_special_methods(app):
"""
Enable documenting "special methods" using the autodoc_ extension.
:param app: The Sphinx application object.
This function connects the :func:`special_methods_callback()` function to
``autodoc-skip-member`` events.
.. _autodoc: http://www.sphinx-doc.org/en/stable/ext/autodoc.html
"""
app.connect('autodoc-skip-member', special_methods_callback)
def special_methods_callback(app, what, name, obj, skip, options):
"""
Enable documenting "special methods" using the autodoc_ extension.
Refer to :func:`enable_special_methods()` to enable the use of this
function (you probably don't want to call
:func:`special_methods_callback()` directly).
This function implements a callback for ``autodoc-skip-member`` events to
include documented "special methods" (method names with two leading and two
trailing underscores) in your documentation. The result is similar to the
use of the ``special-members`` flag with one big difference: Special
methods are included but other types of members are ignored. This means
that attributes like ``__weakref__`` will always be ignored (this was my
main annoyance with the ``special-members`` flag).
The parameters expected by this function are those defined for Sphinx event
callback functions (i.e. I'm not going to document them here :-).
"""
if getattr(obj, '__doc__', None) and isinstance(obj, (types.FunctionType, types.MethodType)):
return False
else:
return skip
autodoc-skip-member回调函数的优点是，与使用special-members选项相比（对我来说），special-members选项还启用了诸如__weakref__之类的属性的文档（在所有新式类上都可用，据我所知），而我认为这是噪音，没有任何用处。回调方法避免了这种情况（因为它仅适用于函数/方法并忽略其他属性）。setup(app) 才能被 Sphinx 执行。 - oarfish__init__ 方法有一个非空的文档字符串。是这样吗？ - xolox..autoclass:: MyClass1
:members:
:class-doc-from: class
..autoclass:: MyClass2
:members:
:class-doc-from: init
:class-doc-from: class - Harshil Mehta这是一种变体，仅在具有参数时包括__init__：
import inspect
def skip_init_without_args(app, what, name, obj, would_skip, options):
if name == '__init__':
func = getattr(obj, '__init__')
spec = inspect.getfullargspec(func)
return not spec.args and not spec.varargs and not spec.varkw and not spec.kwonlyargs
return would_skip
def setup(app):
app.connect("autodoc-skip-member", skip_init_without_args)
"both" Both the class’ and the __init__ method’s docstring are concatenated and inserted.-> 因此，如果你有类的docstring，它不应该只是__init__(self)，而且还应该包括类的docstring。你能提供一个测试用例吗？因为如果是这样，感觉像是一个bug，对吧？ - László Papp