Sphinx构建Read the Docs项目时找不到linuxdoc模块如何解决?
解决方案
你的问题根因是Read the Docs的云端构建环境没有预安装你用到的linuxdoc扩展,和conf.py的路径配置无关,不需要手动加路径,按以下步骤操作即可解决:
步骤1:创建依赖声明文件
在你的项目根目录新建requirements.txt文件,写入以下内容(可补充你其他构建文档需要的依赖):
sphinx==4.1.2 # 建议和你本地用的sphinx版本保持一致,避免版本兼容问题 git+http://github.com/return42/linuxdoc.git
步骤2:配置Read the Docs构建规则
在项目根目录新建.readthedocs.yaml文件,写入以下配置:
version: 2 build: os: ubuntu-22.04 tools: python: "3.7" # 可替换为你本地使用的Python版本,和本地环境对齐降低兼容风险 python: install: - requirements: requirements.txt # 指定依赖安装文件路径 sphinx: configuration: conf.py # 如果你的conf.py在docs文件夹下,就改成docs/conf.py,按实际路径调整
步骤3:提交文件重新构建
把新增的requirements.txt和.readthedocs.yaml提交到GitHub,再触发Read the Docs的构建即可。
补充说明
如果需要查找本地linuxdoc的安装位置,执行命令pip show linuxdoc,输出结果中的Location字段就是安装路径。但该路径仅适用于本地环境,不可硬编码到conf.py中,云端环境路径和本地完全不同,硬编码会导致新的报错。
内容的提问来源于stack exchange,提问作者JeffR
相关产品推荐
相关产品推荐

