You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

Read the Docs构建时sphinx-click模块缺失,本地正常如何解决?

解决Read the Docs上sphinx-click模块找不到的问题

检查依赖配置文件

Read the Docs有时不会自动识别setup.py里的install_requires,尤其是文档结构和Python包结构分离的场景。直接在项目根目录新建requirements.txt文件,明确写入sphinx-click依赖:

sphinx-click>=3.0.0  # 可根据需求指定对应版本

之后进入Read the Docs的项目设置,找到Build选项卡,确认Requirements file字段指向该文件(通常会自动检测,未检测到则手动填写路径)。

核对构建环境版本

确保Read the Docs使用的Python版本和你本地构建版本一致,版本不匹配可能导致依赖安装异常。在项目设置的Python version选项中选择与本地相同的版本。
如果项目使用pyproject.toml,也可在文件中添加文档专属依赖组:

[project.optional-dependencies]
docs = [
    "sphinx-click>=3.0.0",
]

随后在Read the Docs设置里指定安装命令为pip install .[docs]。

手动添加预构建命令

若上述方法无效,进入项目的Advanced Settings,找到Pre-build command,添加强制安装命令:

pip install sphinx-click

让服务器在构建文档前先安装该模块。

内容的提问来源于stack exchange,提问作者justinian482

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.17 06:54:58