如何在我的Sphinx文档中显示变量名称和描述？

Question

我正在使用Sphinx来记录我的Python项目。这向我展示了项目的所有方法，但没有显示任何变量。我希望能够列出所有变量。

我的代码。第一次是 -

Code Documentation
=====================
.. automodule:: sql_fn
   :members:

目前，我的python项目是这样的 -

#test variable
var=0
test_fn():
    '''test function'''
    print "hello world"

如何更改code.rst或我的项目以显示我的var及其说明test variable？

Answer 1

回答我自己的问题 -

要记录变量，其前面的注释必须以#:开头，而不仅仅是#。然后，Sphinx将其识别为即将发生的变量的评论。

#:test variable
var=0
test_fn():
    '''test function'''
    print "hello world"

Answer 2

一种常见的方法是记录函数docstring中的变量。见Google Style Python Docstrings。如果变量不在函数中，您应该在包含模块的文档字符串中记录它。