Autodoc在本地有效，但在ReadTheDocs上无效

9 投票

1 回答

1739 浏览

提问于 2025-04-18 13:42

我用自动文档工具记录了一些函数，自己在本地运行得很好。可是当我把代码提交到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文件）

documentation automodule conf.py autodoc c language shared library readthedocs

1 个回答

在查看了你的源文件和日志文件后，我得出了两个结论：

你为什么在conf.py文件中把这一行sys.path.insert(os.path.abspath('../..'))注释掉了？如果你查看日志，RTD找不到你的模块。那一行代码可以帮你设置正确的路径。
你还需要把你的C库也作为一个模拟模块。

回答于 2025-04-18 由 Python大师

分享举报