Autodoc在本地工作,但不在ReadTheDocs上

时间:2014-07-17 13:54:32

标签: python python-sphinx autodoc

我使用autodoc记录了一些函数。在当地它运作良好。 当我提交GitHub时,文档是基于ReadTheDocs构建的,但是没有我用“automodule”记录的函数。

我在conf.py中添加了:

import mock

MOCK_MODULES = ['numpy', 'scipy']
for mod_name in MOCK_MODULES:
   sys.modules[mod_name] = mock.Mock() 

但它没有帮助。

这可能与我使用自己的C库有关吗? (我编译的 .c 文件是 .so

1 个答案:

答案 0 :(得分:5)

在阅读完源文件和日志文件之后,我收集了两件事:

  1. 为什么你在conf.py中注释掉sys.path.insert(os.path.abspath('../..'))行?如果您阅读日志,RTD无法找到您的模块。那条线将走上正确的道路。

  2. 您还需要将C库作为模拟模块。