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

【问题标题】：How do I show variable names and descriptions in my Sphinx documentation?如何在我的 Sphinx 文档中显示变量名称和描述？
【发布时间】：2014-07-23 19:15:59
【问题描述】：

我正在使用 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？

【问题讨论】：

标签： python python-sphinx documentation-generation restructuredtext

【解决方案1】：

回答我自己的问题-

要记录一个变量，它前面的注释必须以#: 开头，而不仅仅是#。然后，Sphinx 将其识别为即将到来的变量的注释。

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

【讨论】：

【解决方案2】：

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

【讨论】：