我想通过它的文档字符串来记录一个常量。我不想让价值出现。如果我有一个很长的列表,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.
"""
Run Code Online (Sandbox Code Playgroud)
我尝试了以下方法:
.. autoclass:: module_level_variable2
Run Code Online (Sandbox Code Playgroud)
根本不显示文档字符串。
.. autodata:: module_level_variable2
Run Code Online (Sandbox Code Playgroud)
确实显示文档字符串和数据。
.. automethod:: module_level_variable2
Run Code Online (Sandbox Code Playgroud)
和 .. 自动属性:: module_level_variable2
不要在文档中显示任何内容(甚至不显示变量的名称)。
.. autofunction:: module_level_variable2
Run Code Online (Sandbox Code Playgroud)
只显示文档字符串。这几乎就是我想要的。但是,它通过向其添加括号将常量视为 function() - 这是错误的(为什么在make html!
我浏览了http://www.sphinx-doc.org/en/1.4.8/ext/autodoc.html但找不到告诉.. autodata::不显示数据本身的开关(但仅显示文档字符串)。
解决方案
.. autodata:: module_level_variable2
:annotation:
Run Code Online (Sandbox Code Playgroud)
| 归档时间: |
|
| 查看次数: |
2173 次 |
| 最近记录: |