从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到文件并对其进行编辑有多困难？