Python sphinx 在Sphinx中,通过_getattr提供的文档属性__

Python sphinx 在Sphinx中,通过_getattr提供的文档属性__,python-sphinx,Python Sphinx,在Python的Sphinx中,如何记录由于\uu getattr\uuu而可用的属性 我有一个配置管理器的实例,它允许通过与节名匹配的属性访问配置的任何节,即配置管理器。 现在,我在.rst文件中(但更喜欢在代码中)记录了以下内容: .. autoclass:: ConfigManager :members: :var .<section_name>: Access any section of the configuration by its name. ..

在Python的Sphinx中,如何记录由于
\uu getattr\uuu
而可用的属性

我有一个配置管理器的实例,它允许通过与节名匹配的属性访问配置的任何节,即
配置管理器。

现在,我在.rst文件中(但更喜欢在代码中)记录了以下内容:

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

    .. attribute:: <section_name>

       Access any section of the configuration by its name.
。。自动类::配置管理器
:成员:
:var.:通过名称访问配置的任何部分。

但是这在文档中并不是很明显,即使提供这种访问是该类的主要目的之一。

您可以使用
。。属性::
指令,如下所示:

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

    .. attribute:: <section_name>

       Access any section of the configuration by its name.
。。自动类::配置管理器
:成员:
.. 属性::
通过名称访问配置的任何部分。

属性将出现在输出中的方法之前(并像方法一样显示)。

您所说的“这不会显得太突出”是什么意思?有什么东西出现了吗?方法出现了我会称之为突出的东西。我用
:var
注释的这个东西显示在类描述下面,作为“变量:项目符号列表”。我也希望它们显示为方法。为什么您希望它们显示为“方法”?它们不是方法。我遗漏了什么吗?他们实际上是公众成员。我的错误是,我不希望它们显示为方法,就像方法(或属性,或公共属性)一样。这太完美了。谢谢当我将它移动到类的docstring时,它甚至可以工作。