Атрибут одиночного модуля Autodoc в Sphinx

Question

Скажем, я задокументировал переменную в модуле Python, вот так:

some_random_name = 'whatever'
"""The random whatever variable"""

Могу ли я включить автодок для этой единственной переменной в мой файл.rst, не перетаскивая в модуль __doc__ строка и генерация выходной документации для этого тоже?

я пытался

.. automodule: themodule
   :members: some_random_name

но оба тащат в __doc__ строка и не показывает автодок для some_random_name,

Answer 1

Я не могу воспроизвести проблему с документированием атрибута модуля. Меня устраивает. У вас случайно есть __all__ переменная в вашем модуле, значение которой не включает some_random_name? Сфинкс считает __all__ при поиске членов.

Строка документации модуля может быть удалена путем перехвата autodoc-process-docstring событие. Вот демонстрация (добавьте код в conf.py):

import inspect

def remove_mod_docstring(app, what, name, obj, options, lines):
    """Erase module docstring in-place"""  
    if inspect.ismodule(obj):
        for i in xrange(len(lines)):
            lines[i] = ''

def setup(app):
    app.connect('autodoc-process-docstring', remove_mod_docstring)