我正在使用sphinx自动记录项目,我有一个类,我需要记录每个属性。该类位于core.transactions.can,“can”类有一个很大的属性列表,这些属性在同一行上以“#:...”的形式包含python注释,这些注释遵循找到的文档{{3 }}
因为我已经在conf.py中设置了路径,所以我当前记录了这样的事务模块:
.. automodule:: transactions
:members:
:private-members:
:special-members:
:exclude-members: __weakref__
但这些属性没有记录在案。
我也尝试过使用以下各项:
.. autofunction:: transactions.can
.. autodata:: transactions.can
.. automethod:: transactions.can
.. autoattribute:: transactions.can
我认为自动属性是我想要的,但它似乎没有记录任何内容。
一旦这些属性记录如下:
class can:
some_attribute = False #: This is what some_attribute does
如何在sphinx文档中显示此内容?