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

Question

我正在使用Sphinx来为我的Python项目写文档。它能显示项目中的所有方法，但不显示任何变量。我希望也能列出所有变量。

我的code.rst文件内容是 -

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

一个常见的方法是在你函数的文档字符串里记录变量的信息。你可以参考一下谷歌风格的Python文档字符串。如果这个变量不在某个函数里，那你应该在包含它的模块的文档字符串里进行记录。

Answer 2

我来回答我自己的问题-

要给一个变量添加说明，前面的注释必须以 #: 开头，而不是单纯的 #。这样，Sphinx 就会把它识别为即将要说明的变量的注释。

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