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

Question

我使用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)

Answer 1

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

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

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