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

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

这是三种选择：

1. 为了确保

   __init__()

   始终记录

   autodoc-skip-member

   在文档中，可以在conf.py中使用。像这样：

   def skip(app, what, name, obj, would_skip, options):if name == "__init__":    return Falsereturn 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

，如对此答案的第一个修订版的注释中指出的那样）。