我想通过其docstring记录一个常量。我不想让价值出现。如果我有一个长名单,Sphinx将完全包含它,我不想要。如果只显示摘录(带省略号或其他),对我来说没问题。但不是数千个列表元素。
module_level_variable2 = 98765
"""int: Module level variable documented inline.
The docstring may span multiple lines. The type may optionally be specified
on the first line, separated by a colon.
"""
我尝试了以下内容:
.. autoclass:: module_level_variable2
根本不显示文档字符串。
.. autodata:: module_level_variable2
会显示docstring和数据。
.. automethod:: module_level_variable2
和 .. autoattribute :: module_level_variable2
不要在文档中显示任何内容(甚至不是变量的名称)。
.. autofunction:: module_level_variable2
仅显示docstring。这几乎就是我想要的。但是,它通过向括号添加括号来将常量视为函数() - 这是错误的(为什么会在make html
上引发警告!
我经历了http://www.sphinx-doc.org/en/1.4.8/ext/autodoc.html但找不到转换来告诉.. autodata::
不要显示数据本身(仅限文档字符串)。
解
.. autodata:: module_level_variable2
:annotation: