狮身人面像命名特殊成员

Question

[这是我第一次使用Sphinx，到目前为止我已经弄清楚了很多，但是有一个特别的警告提示我无法弄清楚它在告诉我什么。

根据http://www.sphinx-doc.org/en/stable/ext/autodoc.html上的文档，如果指定了special-members标志选项，则将包括Python“特殊”成员（即名称为special的成员）：

.. autoclass:: my.Class
    :members:
    :private-members:
    :special-members:

将记录该类的”私人”和”特殊”成员。1.1版的新功能。在版本1.2中更改：该选项现在可以接受参数，即文档的特殊成员。

我正在尝试在文档中列出某个类的__init__，但没有其他特殊成员，因此我的.rst文件是这样的：

**myClass Class**
==================

.. automodule:: python_module.submodule.series.myClass
    :members:

    .. autoclass:: myClass
        :members:
        :special-members: __init__

我收到错误“ .rst：7：警告：缺少属性：special-members：对象python_module.submodule.series.myClass.myClass中的init

我使用的是Sphinx版本1.5.1，因此当我传递给我要记录的特殊成员的名称时，该功能不应该吗？该错误使我好像从我的.py文件中缺少某些内容，而我正在从中提取文档字符串。是这样吗如果要执行此操作，我找不到方法中需要特别说明的任何内容。

Answer 1

我确实发现类文档字符串被重复两次是因为..automodule部分。我把它取出来，它仍然包含整个类的定义，这让我很高兴。

我仍然无法使用：special-members：选项来记录__init__定义，但这是一个可以忽略的问题，因为该类已被充分记录。所以我想我现在只允许这个警告使我难过...]

Answer 2

请注意，如果您在谈论课程，则应使用：