如何使用Sphinx的自动文档来记录类的__init __（self）方法？

Question

Sphinx默认情况下不会为__init __（self）生成文档。我尝试了以下方法：

.. automodule:: mymodule
    :members:

和

..autoclass:: MyClass
    :members:

在conf.py中，设置以下内容只会将__init __（self）文档字符串附加到类文档字符串（Sphinx
autodoc文档
似乎同意这是预期的行为，但未提及我要解决的问题）：

autoclass_content = 'both'

Answer 1

这是三种选择：

1. 为了确保__init__()始终记录autodoc-skip-member在文档中，可以在conf.py中使用。像这样：

   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)
   

这明确定义了__init__不被跳过（默认情况下为跳过）。仅一次指定此配置，并且.rst源中的每个类都不需要任何其他标记。

1. 该special-members选项已在Sphinx 1.1中添加。它使__special__autodoc记录“特殊”成员（名称如的成员）。

从Sphinx 1.2开始，此选项接受参数，这使其比以前更有用。

1. 用途automethod：

   .. autoclass:: MyClass
   

   :members:

   .. automethod:: init

这必须为每个类添加（不能与一起使用automodule，如对此答案的第一个修订版的注释中指出的那样）。