python - Sphinx 是否可以处理不能很好地导入的代码？

Question

Sphinx 文档引擎是否会成功地为一个不能很好导入的项目生成文档？特别是我的项目有一个异国情调的依赖。我不希望文档生成依赖于这种依赖关系。

Sphinx 需要导入我的模块并使用自省还是解析？

Answer 1

如果您使用的是 autodoc 扩展，那么是的，您的项目必须是可导入的。但有时可以模拟出你的依赖项conf.py（因为大概在导入时，依赖项只是名义上需要的）。Read the Docs 文档中有一个如何执行此操作的示例。

Answer 2

Core Sphinx 根本不会触及您的代码。autodoc扩展确实如此，并且确实导入了它：

为了让 Sphinx（实际上是执行 Sphinx 的 Python 解释器）找到您的模块，它必须是可导入的。