Почему Sphinx не поддерживает переменные модуля autodoc?

Я хочу иметь автоматическую документацию для переменных модуля, но это просто не работает. В документе отсутствуют все переменные ... Как я могу это исправить, чтобы autodoc отображал каждую переменную модуля?

mypackage / __ init__.py:

class __init__:
    test = 'test'
    _test = '_test'
    __test = '__test'
    __test__ = '__test__'

__author__ = 'author'
__email__ = 'author_email'
__description__ = 'description'
__version__ = 'version'

И изображение документов:

введите описание изображения здесь


python-sphinx autodoc
person Community    schedule 01.08.2015    source источник
comment
Модули с подчеркиванием считаются внутренними модулями в соответствии с лучшими практиками Python, и я полагаю, что autodoc не документирует их по умолчанию. Вы можете проверить эту опцию в документации Sphinx или явно указать __all__, чтобы указать, какие переменные модуля вы экспортируете.   -  person Mikko Ohtamaa    schedule 01.08.2015
comment
Я пробовал, но безуспешно. Думаю, это баг ...   -  person    schedule 01.08.2015

Ответы (1)


arrow_upward
0
arrow_downward

Используйте 1_

.. autoclass:: my.Class
   :members:
   :private-members:
   :special-members:

http://sphinx-doc.org/ext/autodoc.html

person Mikko Ohtamaa    schedule 01.08.2015
comment
Я уже сделал это в файле conf.py ... autodoc_default_flags = ['members','special-members','private-members','undoc-members'] и, поскольку я вижу частные и специальные классы, я знаю, что это уже работает, но не для частных модулей ... Может быть, есть разница в версии Python? - person ; 02.08.2015