Если у меня есть файл foo.baz.py
:
from foo.bar.baz import Quux, Quuux
__all__ = ['Quux', 'Quuux']
Я хотел бы задокументировать api следующим образом:
Baz
===
.. currentmodule:: foo.baz
.. autosummary::
:toctree: generated/
:nosignatures:
Quux
Quuux
Это дает мне таблицу автосводки с Quux
и Quuux
и ссылки на страницы, содержащие их полную документацию. Однако для этого необходимо явно указать Quux
и Quuux
, поэтому всякий раз, когда я добавляю класс, мне приходится вручную добавлять его в документацию.
Вместо этого я бы предпочел сделать что-то подобное, и он автоматически сгенерирует таблицу на основе __all__
, чтобы получить точно такой же результат, как указано выше:
Baz
===
.. currentmodule:: foo
.. autosummary::
:toctree: generated/
:nosignatures:
baz
Но это не работает, создается таблица с единственной записью, модуль baz
, ведущая к странице со всем ее содержимым, а также к сводной таблице.
Есть ли способ добиться этого? Если это актуально, я использую numpydoc
.
autosummary
с параметромrecursive
: stackoverflow.com/a/62613202/407651 - person mzjn   schedule 30.06.2021