本文介绍了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格式记录数据的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持编程学习网！
本站部分内容来源互联网,如果有图片或者内容侵犯您的权益请联系我们删除！