答案 0 :(得分：56)
您可以尝试使用sphinx-apidoc。
$ sphinx-apidoc --help
Usage: sphinx-apidoc [options] -o <output_path> <module_path> [exclude_paths, ...]
Look recursively in <module_path> for Python modules and packages and create
one reST file with automodule directives per package in the <output_path>.
你可以将sphinx-apidoc和sphinx-quickstart混合起来，以便像这样创建整个doc项目：
$ sphinx-apidoc -F -o docs project
此调用将使用sphinx-quickstart生成一个完整项目，并在（项目）中递归查找Python模块。
希望这有帮助！
答案 1 :(得分：17)
答案 2 :(得分：4)
注意
对于Sphinx（实际上是执行的Python解释器） Sphinx）找到你的模块，它必须是可导入的。这意味着 模块或包必须位于其中一个目录中 sys.path - 相应地调整配置文件中的sys.path
所以，转到你的conf.py并添加
import an_example_pypi_project.useful_1
import an_example_pypi_project.useful_2
现在你的index.rst看起来像是：
.. toctree::
:glob:
example
an_example_pypi_project/*
和
make html
答案 3 :(得分：1)
从Sphinx 3.1版（2020年6月）开始，如果您很高兴使用sphinx.ext.autosummary显示摘要表，则可以使用新的:recursive:选项自动检测包中的每个模块，但是嵌套，并自动为该模块中的每个属性，类，函数和异常生成文档。