使用Sphinx为每个功能自动生成单独的文档

Question

我一直在构建具有许多不同功能的Python模块。

我正在使用Sphinx和readthedocs提供文档。我已经取得了不错的进步，但是目前我有一个庞大的页面，该页面提供了所有功能的文档（按字母顺序）。

我看过其他项目，每个项目都有单独的页面。在查看它们的源代码时，我发现已经为每个文件创建了一个单独的.rst文件。我假设这是自动完成的，并且此页面有关生成自动文档摘要的内容似乎在描述其中的某些内容，但我对此无能为力。

sphinx-apidoc
有一个选项（-e）为每个模块创建一个页面，但是我希望为每个功能一个页面。

如何使用Sphinx为每个功能自动生成单独的页面？

附加信息

要添加以下答案之一的信息，我将以下内容放入了EoN.rst文件中，该文件位于子目录中docs。

EON documentation
=================

.. automodule:: ../EoN
   :members:

.. currentmodule:: ../EoN

.. autosummary::
   :toctree: functions

   fast_SIR
   fast_SIS

我收到错误消息

$ sphinx-autogen -o docs/generated docs/*.rst

[autosummary]为以下项目生成自动摘要：docs / index.rst，docs / methods.rst，docs /
quickstart.rst

[自动摘要]写入docs / generated

警告：[自动摘要]无法导入u’fast_SIR’：没有名为fast_SIR的模块

警告：[autosummary]无法导入u’fast_SIS’：没有名为fast_SIS的模块

fast_SIS和fast_SIR坐在内../EoN.py

Answer 1

在使用sphinx和’autodoc’的按类排序显示的答案中？它说明了如何使用autosummary和来为每个类一页生成类的文档autosummary_generate=True。

该机制也适用于功能。使用这样的东西：

EoN API documentation
=====================

.. currentmodule:: EoN

.. autosummary::
   :toctree: functions

   my_function1
   my_function2
   my_function3
   ...

您必须在autosummary指令中枚举每个函数，但是相应的*.rst文件会自动生成（在functions子目录中）。