如何让sphinx文档化一个包的__init__.py文件

Question

我有一个用sphinx文档格式化的软件包。该软件包包含一些本地模块（使用boost-python生成）和一个__init__.py。

__init__.py包含了一系列经过文档记录的monkey patch操作以及提供了一些方便的函数。

我未能找到如何告诉sphinx基于__init__.py生成包级别文档，所有我在搜索中找到的都是如何从类__init__方法生成文档，这不是我想要的。

- Stephen

---

.. automodule:: yourpackage 应该可以正常工作，使用 :members: 选项。 - mzjn

@mzjn 我实际上运行了sphinx-apidoc -f ...命令，并且生成了.. automodule:: mypackage以及：members:选项。可惜没有成功。:( - Stephen

今天测试了，对我来说仍然是个问题。 - decadenza

Answer 1

在我的情况下，我只是使用命令sphinx-apidoc -f -e -o ./source ..，并且对于"模块内容"文档部分中的包，我从__init__.py获取docstrings。顺便说一句，您应该查看模块中的导入 - 当我有一些错误的导入时，这些文件被跳过了。修复后我得到了文档。

- Artem S. Zhelonkin