sphinx: document data in python without displaying the data(Sphinx:在不显示数据的情况下以Python格式记录数据)
本文介绍了Sphinx:在不显示数据的情况下以Python格式记录数据的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!
问题描述
我知道我可以document (module) constants in sphinx使用
#: a tuple of primes
primes = (2, 3, 5, 7, 11, 13, 17)
或
primes = (2, 3, 5, 7, 11, 13, 17)
"""a tuple of primes"""
它随后将出现在狮身人面像生成的文档中;即它将如下所示:
somemodule.primes
= (2, 3, 5, 7, 11, 13, 17)
素数元组
但如果数据是非常长的列表怎么办?然后我希望能够在文档中有一个文档字符串,但不能在文档中有实际数据本身。
这是我希望在文档中包含的内容:
somemodule.primes
素数元组
有什么方法可以实现这一点吗?
为完整性:
我运行了sphinx-quickstart
并启用了自动文档:
autodoc: automatically insert docstrings from modules (y/n) [n]: y
我添加到index.rst
的唯一内容是:
``somemodule``
**************
.. automodule:: somemodule
:members:
和somemodule.py
包含以下内容:
#: a tuple of primes
primes = (2, 3, 5, 7, 11, 13, 17)
然后我修改了conf.py
中的sys.path
,使somemodule.py
位于该路径中。
推荐答案
以防有人到了这里。若要隐藏变量的内容,请使用meta info list field。
Example:
primes = (2, 3, 5, 7, 11, 13, 17)
"""A tuple of primes.
:meta hide-value:
"""
这篇关于Sphinx:在不显示数据的情况下以Python格式记录数据的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持编程学习网!
沃梦达教程
本文标题为:Sphinx:在不显示数据的情况下以Python格式记录数据


基础教程推荐
猜你喜欢
- 如何在 Python 中检测文件是否为二进制(非文本)文 2022-01-01
- 哪些 Python 包提供独立的事件系统? 2022-01-01
- 将 YAML 文件转换为 python dict 2022-01-01
- 症状类型错误:无法确定关系的真值 2022-01-01
- 使 Python 脚本在 Windows 上运行而不指定“.py";延期 2022-01-01
- 如何在Python中绘制多元函数? 2022-01-01
- 使用 Google App Engine (Python) 将文件上传到 Google Cloud Storage 2022-01-01
- 合并具有多索引的两个数据帧 2022-01-01
- 使用Python匹配Stata加权xtil命令的确定方法? 2022-01-01
- Python 的 List 是如何实现的? 2022-01-01