我想为我的包生成文档。项目中的每个文件都包含大量文档。有没有办法快速将我的整个项目添加到文档索引中？
我想用尽可能少的工作为整个项目自动生成一些文档。我首先将以下内容添加到 index.rst:
.. automodule:: mymodulename
:members:
似乎所做的只是 __init__.py 文件中的文档元素(只是一个文档字符串)——有什么方法可以让它记录其他所有内容吗？我希望添加包中定义的所有内容，并将包中的每个类、常量、函数(等)添加到适当的索引中。
这可以做到吗？
最佳答案
您可以使用sphinx-apidoc。
来自official documentation : sphinx-apidoc 是一个自动生成 Sphinx 源代码的工具，它使用 autodoc 扩展，以其他自动 API 文档工具的风格记录整个包。
一个用法示例可以是(从您的项目根目录):
$ sphinx-apidoc . --full -o doc -H 'MyProject' -A 'MyName' -V '1.0'
一个 doc 目录将被创建，里面的所有东西都准备好了。
您还可以调整文档的设置，编辑自动生成的 conf.py 文件。
其他有用的信息可以在 similar question posted here 中找到.
关于python - 在 Sphinx 文档生成器中，我可以将整个包(递归地)添加到索引中吗？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/8792643/