递归使用 Sphinx 自动摘要生成 API 文档

Question

我想使用 Sphinx 的 autosummary extension 和 templates 从文档字符串递归生成 API 文档。我想要每个模块、类、方法、属性和函数的单独页面。但它根本没有检测到我的模板。事实上，如果我只是从_templates/autosummary/ 中删除module.rst 文件，它会以与以前完全相同的方式呈现整个文件。我已经关注this SO question 到这封信。如果你有兴趣，the full repository is on GitHub。

编辑：它似乎确实生成了一个不同的文件，我必须删除 docs/_autosummary 才能读取新模板。但是，现在它会生成一个带有sparse 标头和description 标头的文件。它不会进入 {% if classes %} 和 {% if functions %} 指令。

我的目录结构如下：

• 稀疏
• 文档
  • conf.py
  • index.rst
  • modules.rst
  • _templates/autosummary/module.rst

以下是目前的相关文件：

index.rst:

.. sparse documentation master file, created by
   sphinx-quickstart on Fri Dec 29 20:58:03 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to sparse's documentation!
==================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   modules

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

modules.rst:

API Reference
=============

Modules
-------

.. autosummary::
   :toctree: _autosummary

   sparse

_templates/autosummary/module.rst:

{{ fullname | escape | underline }}

Description
-----------

.. automodule:: {{ fullname | escape }}

{% if classes %}
Classes
-------
.. autosummary:
    :toctree: _autosummary

    {% for class in classes %}
        {{ class }}
    {% endfor %}

{% endif %}

{% if functions %}
Functions
---------
.. autosummary:
    :toctree: _autosummary

    {% for function in functions %}
        {{ function }}
    {% endfor %}

{% endif %}

Answer 1

我最终需要以下文件：

modules.rst:

API Reference
=============

.. rubric:: Modules

.. autosummary::
   :toctree: generated

   sparse

_templates/autosummary/module.rst:

{{ fullname | escape | underline }}

.. rubric:: Description

.. automodule:: {{ fullname }}

.. currentmodule:: {{ fullname }}

{% if classes %}
.. rubric:: Classes

.. autosummary::
    :toctree: .
    {% for class in classes %}
    {{ class }}
    {% endfor %}

{% endif %}

{% if functions %}
.. rubric:: Functions

.. autosummary::
    :toctree: .
    {% for function in functions %}
    {{ function }}
    {% endfor %}

{% endif %}

_templates/autosummary/class.rst:

{{ fullname | escape | underline}}

.. currentmodule:: {{ module }}

.. autoclass:: {{ objname }}

   {% block methods %}
   {% block attributes %}
   {% if attributes %}
   .. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
      .. autosummary::
         :toctree:
      {% for item in all_attributes %}
         {%- if not item.startswith('_') %}
         {{ name }}.{{ item }}
         {%- endif -%}
      {%- endfor %}
   {% endif %}
   {% endblock %}

   {% if methods %}
   .. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
      .. autosummary::
         :toctree:
      {% for item in all_methods %}
         {%- if not item.startswith('_') or item in ['__call__'] %}
         {{ name }}.{{ item }}
         {%- endif -%}
      {%- endfor %}
   {% endif %}
   {% endblock %}

_templates/autosummary/base.rst:

{{ fullname | escape | underline}}

.. currentmodule:: {{ module }}

.. auto{{ objtype }}:: {{ objname }}

我还需要去sphinx/ext/autosummary/generate.py并在函数generate_autosummary_docs中设置imported_members=True。

如果您不像我一样使用numpydoc，您可能需要删除.. HACK 指令。

Answer 2

从 Sphinx 版本 3.1（2020 年 6 月）开始，您可以使用新的 :recursive: 选项来获取 sphinx.ext.autosummary 来自动检测包中的每个模块，无论嵌套多么深，并为每个属性、类、函数自动生成文档以及该模块中的异常。

在这里查看我的答案：https://stackoverflow.com/a/62613202/12014259