Sphinx会使用不能很好导入的代码吗?

时间:2013-06-28 15:50:55

标签: python documentation python-sphinx

Sphinx文档引擎是否会成功生成不能导入良好的项目的文档?特别是我的项目具有异国情调。我不希望文档生成依赖于这种依赖。

Sphinx是否需要导入我的模块并使用内省或解析?

2 个答案:

答案 0 :(得分:4)

如果您正在使用autodoc扩展,那么是的,您的项目必须是可导入的。但有时可以在conf.py中模拟出依赖关系(因为,据推测,在导入时,只需要名称中的依赖关系)。阅读文档文档中有一个how to do this的示例。

答案 1 :(得分:1)

Core Sphinx根本不会触及您的代码。 autodoc扩展名确实存在,它确实会导入它:

  

对于Sphinx(实际上是执行Sphinx的Python解释器)来查找模块,它必须是可导入的。

相关问题