Question

我有一个带有几个.py文件的项目，只包含一些词典。像这样：

# My file
dictionary = {'key1': 'value1', 'key2: 'value2'}

但是更大更长，我想用Sphinx记录这个，但我不能让它正常工作。

Sphinx找到的文件很好，并在Modules下显示为folder.file但它们都是空的？我究竟做错了什么？字典为什么不出现？

在它显示的文件夹的.rst文件中：

    folder.file module
--------------------

.. automodule:: folder.file
    :members:
    :undoc-members:
    :show-inheritance:

我错过了什么吗？提前谢谢！

Answer 1

对于非类或方法的所有成员，Sphinx确实需要额外的文档字符串。您可能不想编辑autodoc（即使这在某些情况下可以方便个性化），您可以通过在变量下添加文档字符串来克服此问题：< / p>

# My file
dictionary = {'key1': 'value1', 'key2': 'value2'}
'''A dictionary containing secret values.

Do not expose this dictionary's values to the public. By default, the 
keys 'key1' and 'key2' are available.'''

使用Sphinx列出文档中的词典

1 个答案: