在Sphinx中，通过__getattr__提供的文档属性

Question

在Python的Sphinx中，如何通过__getattr__记录可用的属性？

我有一个配置管理器的实例，允许通过与部分名称匹配的属性config_manager.<section_name>访问配置的任何部分。

现在我将这个内部.rst文件（但更喜欢在代码中）记录下来：

.. autoclass:: ConfigManager
    :members:
    :var .<section_name>: Access any section of the configuration by its name.

但是这并不会在文档中显得过于突出，即使提供这种访问是该类的主要目的之一。

Answer 1

您可以使用.. attribute::指令，如下所示：

.. autoclass:: ConfigManager
    :members:

    .. attribute:: <section_name>

       Access any section of the configuration by its name.

属性将出现在输出中的方法之前（和方法一样呈现）。