如何让 sphinx 记录包的 __init__.py 文件

Question

我有一个包，我想用 sphinx 记录。该包由几个本机模块（使用 boost-python 生成）和一个__init__.py

所述__init__.py确实一堆升压Python模块的（记录的）猴修补的，并提供了一堆便利功能。

我一直无法弄清楚如何告诉 sphinx 基于__init__.py. 我在搜索中发现的只是如何让 sphinx 从类__init__方法生成文档，这不是我所追求的。

Answer 1

就我而言，我只使用该命令sphinx-apidoc -f -e -o ./source ..，对于文档的“模块内容”部分中的包，我从__init__.py. 顺便说一句，您应该查看模块中的导入 - 虽然我有一些错误的导入，但这些文件被跳过。修复后我得到了文档。