Sphinxバージョン3.1（2020年6月）以降、sphinx.ext.autosummary（ついに！）再帰があります。
したがって、モジュール名をハードコードしたり、Sphinx AutoAPIやSphinx AutoPackageSummaryなどのサードパーティライブラリに依存したりする必要はありません。て自動パッケージを検出し。
ドキュメント化するPython 3.7パッケージの例（GithubのコードとReadTheDocsの結果を参照）：
mytoolbox
|-- mypackage
| |-- __init__.py
| |-- foo.py
| |-- mysubpackage
| |-- __init__.py
| |-- bar.py
|-- doc
| |-- source
| |--index.rst
| |--conf.py
| |-- _templates
| |-- custom-module-template.rst
| |-- custom-class-template.rst
conf.py：
import os
import sys
sys.path.insert(0, os.path.abspath('../..')) # Source code dir relative to this file
extensions = [
'sphinx.ext.autodoc', # Core library for html generation from docstrings
'sphinx.ext.autosummary', # Create neat summary tables
]
autosummary_generate = True # Turn on sphinx.ext.autosummary
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
index.rst（新しい:recursive:オプションに注意してください）：
Welcome to My Toolbox
=====================
Some words.
.. autosummary::
:toctree: _autosummary
:template: custom-module-template.rst
:recursive:
mypackage
これは、パッケージ内のすべてのモジュールを自動的に要約するには十分ですが、深くネストされています。次に、各モジュールについて、そのモジュール内のすべての属性、関数、クラス、および例外を要約します。
奇妙なことに、デフォルトは sphinx.ext.autosummaryテンプレートでは、属性、関数、クラス、および例外ごとに個別のドキュメントページが生成されず、サマリーテーブルからリンクされます。以下に示すように、これを行うためにテンプレートを拡張することは可能ですが、これがデフォルトの動作ではない理由を理解できません-確かに、ほとんどの人はそれを望んでいます。私はそれを機能要求として上げました。
デフォルトのテンプレートをローカルにコピーしてから、それらに追加する必要がありました。
- コピーする
site-packages/sphinx/ext/autosummary/templates/autosummary/module.rstへmytoolbox/doc/source/_templates/custom-module-template.rst
- コピーする
site-packages/sphinx/ext/autosummary/templates/autosummary/class.rstへmytoolbox/doc/source/_templates/custom-class-template.rst
へのフックcustom-module-template.rstはindex.rst:template:オプションを使用して上にます。（その行を削除して、デフォルトのサイトパッケージテンプレートを使用して何が起こるかを確認してください。）
custom-module-template.rst （右側に記載されている追加の行）：
{{ fullname | escape | underline}}
.. automodule:: {{ fullname }}
{% block attributes %}
{% if attributes %}
.. rubric:: Module Attributes
.. autosummary::
:toctree: <-- add this line
{% for item in attributes %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
{% block functions %}
{% if functions %}
.. rubric:: {{ _('Functions') }}
.. autosummary::
:toctree: <-- add this line
{% for item in functions %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
{% block classes %}
{% if classes %}
.. rubric:: {{ _('Classes') }}
.. autosummary::
:toctree: <-- add this line
:template: custom-class-template.rst <-- add this line
{% for item in classes %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
{% block exceptions %}
{% if exceptions %}
.. rubric:: {{ _('Exceptions') }}
.. autosummary::
:toctree: <-- add this line
{% for item in exceptions %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
{% block modules %}
{% if modules %}
.. rubric:: Modules
.. autosummary::
:toctree:
:template: custom-module-template.rst <-- add this line
:recursive:
{% for item in modules %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
custom-class-template.rst （右側に記載されている追加の行）：
{{ fullname | escape | underline}}
.. currentmodule:: {{ module }}
.. autoclass:: {{ objname }}
:members: <-- add at least this line
:show-inheritance: <-- plus I want to show inheritance...
:inherited-members: <-- ...and inherited members too
{% block methods %}
.. automethod:: __init__
{% if methods %}
.. rubric:: {{ _('Methods') }}
.. autosummary::
{% for item in methods %}
~{{ name }}.{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
{% block attributes %}
{% if attributes %}
.. rubric:: {{ _('Attributes') }}
.. autosummary::
{% for item in attributes %}
~{{ name }}.{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
lsファイルにルーティングして編集するのはどれほど難しいですか？