Список словарей в документации с Sphinx

Question

У меня есть проект с несколькими .py файлами, который содержит только несколько словарей. Как это:

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

Но гораздо больше и больше, и я хотел бы задокументировать с Сфинкса, но я не могу заставить его работать правильно.

Файлы найдены Sphinx просто отлично и отображаются под Модулями в виде файла folder.file, но все они пустые? Что я делаю не так? Почему словари не появятся?

в .rst файл для папки показывает:

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

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

я упускаю что-то? Заранее спасибо!

Answer 1

Sphinx требует дополнительных докстерий для всех членов, которые не являются классами или методами. Вы, вероятно, не хотите редактировать autodoc (хотя это может пригодиться для индивидуализации при определенных условиях), вы можете решить эту проблему, добавив строку документации ниже переменной:

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