Я использую расширение Autodoc Sphinx для документирования модуля и хочу получить плоский список членов модуля в выводе документации.
Я пробовал использовать следующее:
.. automodule:: modname
:members:
Однако здесь есть две проблемы:
Он включает строку документации модуля, которую я не хочу здесь .
Имя каждой записи имеет префикс "modname.", Что является полностью избыточным (поскольку эта страница предназначена специально для документирования этого модуля)
Однако мне не удалось найти никаких параметров конфигурации, которые позволили бы я выборочно отключил эти два аспекта, при этом получая автоматический список всех членов модуля.
Мой текущий план состоит в том, чтобы просто использовать автофункцию (и т. Д.) И явно перечислить элементы, которые должны быть задокументированы, но я все же хотел бы знать, не упустил ли я простой способ достичь того, чего я изначально хотел.
Обновление: Я, по крайней мере, нашел обходной путь для второй части: установите add_module_names = False
в conf.py
. Это глобальная настройка, поэтому она не отвечает на мой первоначальный вопрос.