Python 使用Sphinx列出文档中的词典

我有一个只有几个.py文件的项目，其中只包含几个字典。像这样：

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

但要大得多，时间更长，我想用斯芬克斯来记录这一点，但我不能让它正常工作

Sphinx可以很好地找到这些文件，并在模块下显示为folder.file，但它们都是空的吗？我做错了什么？为什么字典不会出现

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

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

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

---

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

Sphinx确实需要为所有非类或方法的成员提供额外的docstring。您可能不想编辑

autodoc

（即使在某些情况下这对于个性化很方便），您可以通过在变量下方添加docstring来解决此问题：

# 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确实需要为所有非类或方法的成员提供额外的docstring。您可能不想编辑

autodoc

（即使在某些情况下这对于个性化很方便），您可以通过在变量下方添加docstring来解决此问题：

# 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.'''

---

可能是的副本也可能是的副本您还可以使用以下格式在词汇表之前添加注释：

：

。但这是单行注释，每行都必须重复

#：：

。您还可以使用以下格式在词汇表之前添加注释：

。：

。但这是单行注释，每行都必须重复

#：：

。