Недавно я попробовал использовать sphinx-apidoc из Sphinx, чтобы помочь сгенерировать специфический для Sphinx reStructuredText из API проекта Python.
Однако я получаю результат:
Кто-нибудь знает, могу ли я настроить шаблон sphinx-api
для его вывода? В частности, я хотел бы:
- Избавьтесь от всех заголовков "Submodules", "Subpackages" и "Module contents" и
- Получают ли результаты из docstring в моих файлах
__init__.py
непосредственно под пакетами, поэтому, если я нажму имя пакета, первое, что я вижу, это документация пакета. На данный момент эта документация помещается под слегка странным заголовком "Module contents" в самом конце каждого раздела пакета.
Заголовки "Submodules" и "Subpackages" являются избыточными, я думаю, поскольку обычные заголовки для пакетов/модулей "xxx.yyy package" и "xxx.yyy.zzz module".
Структура, которая мне нужна для приведенного выше небольшого примера, -
- orexplore.components package
- orexplore.components.mbg120
- пакет orexplore.simulators
- пакет orexplore.simulators.test
- Модуль
- orexplore.simulators.test.mbg120
- orexplore.simulators.mbg120
- пакет orexplore.simulators.test
Если щелкнуть пакеты, первым, что я увижу на странице, будет документация пакета.
Или, может быть, даже просто
- orexplore.components
- orexplore.components.mbg120
- orexplore.simulators
- orexplore.simulators.test
- orexplore.simulators.test.mbg120
- orexplore.simulators.test
- orexplore.simulators.mbg120
если есть какой-то способ визуально различать пакеты/модули (цвет? emblem?) вместо довольно многословного "пакета" и "модуля".