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格式记录数据的教程就到这里就结束了,希望趣模板源码网找到的这篇技术文章能帮助到大家,更多技术教程可以在站内搜索。