我知道我可以

#: a tuple of primes
primes = (2, 3, 5, 7, 11, 13, 17)


primes =  (2, 3, 5, 7, 11, 13, 17)
"""a tuple of primes"""

然后将出现在sphinx生成的文档中;也就是说,它看起来像这样:
somemodule.primes
= (2, 3, 5, 7, 11, 13, 17)
一组素数
但是如果数据是一个很长的列表呢?然后我希望能够在文档中有一个docstring,但在文档中没有实际的数据本身。
这是我想在文件里写的:
somemodule.primes
一组素数
我有办法做到这一点吗?
完整性:
我运行了sphinx-quickstart并启用了autodoc:
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)

然后我调整了sys.path中的conf.py,使somemodule.py位于该路径中。

最佳答案

最后,我在somemodule.primes中没有任何somemodule.py的文档(这使得sphinx忽略了它),并将手动文档放入index.rst

``somemodule``
**************

.. automodule:: somemodule
    :members:

.. py:data:: somemodule.primes

    a tuple of primes

到目前为止,我在somemodule.py中找不到直接做类似事情的方法。

关于python - sphinx:在python中记录数据而不显示数据,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/57752858/

10-10 17:03