求适配sklearn项目模板的Read the Docs v2有效配置文件
适配sklearn项目模板的Read the Docs v2配置文件
以下是符合Read the Docs v2规范、适配sklearn项目模板的有效配置文件,可解决你遇到的numpydoc缺失报错:
version: 2 build: os: ubuntu-22.04 tools: python: "3.10" sphinx: configuration: docs/conf.py # 根据你的项目实际sphinx配置路径调整 python: install: - requirements: requirements.txt - extra_requirements: - tests - docs - method: pip path: . - packages: - numpydoc
关键配置说明:
version: 2:明确指定使用v2配置标准,满足Read the Docs 2023年9月25日之后的构建要求- 构建环境指定:通过
build字段锁定Ubuntu 22.04和Python 3.10,保证构建环境的稳定性和一致性 - Sphinx配置路径:v2版本要求显式指定sphinx配置文件路径,确保文档构建能找到正确的配置
- 依赖安装:
- 读取
requirements.txt安装基础依赖 - 安装
tests和docs额外依赖,对应旧版配置的需求 - 安装项目本身,确保文档构建时能正确导入sklearn相关模块
- 单独安装
numpydoc,直接解决你遇到的模块缺失报错
- 读取
如果你的requirements.txt或docs额外依赖中已经包含numpydoc,可以去掉配置里的- packages: - numpydoc部分。
内容的提问来源于stack exchange,提问作者Rolf Carlson
相关产品推荐
相关产品推荐

