我一直在构建一个具有许多不同功能的 Python 模块。
我正在使用 Sphinx 和 readthedocs 来提供文档。我取得了不错的进展，但目前我有 one massive page它提供了我所有功能的文档(按字母顺序排列)。
我看过其他项目，每个功能都有一个单独的页面。在查看它们的源代码时，我发现每个都创建了一个单独的 .rst 文件。我假设这是自动完成的，this page关于生成 autodoc 摘要似乎描述了其中的一些内容，但我就是无法理解。
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] generating autosummary for: docs/index.rst, docs/methods.rst, docs/quickstart.rst
[autosummary] writing to docs/generated
WARNING: [autosummary] failed to import u'fast_SIR': no module named fast_SIR
WARNING: [autosummary] failed to import u'fast_SIS': no module named fast_SIS
fast_SIS 和 fast_SIR 位于 ../EoN.py
最佳答案
我认为 sphinx-automodapi Sphinx 扩展可以满足您的需求。本质上是记录一个模块，您只需执行以下操作:
.. automodapi:: mypackage.mymodule
它会为每个函数生成表格和单独的页面。
免责声明:我是 sphinx-automodapi 的作者
关于python - 使用Sphinx为每个函数自动生成单独的文档，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/43357912/