Read the Docs autodoc功能PDF正常生效但HTML不加载问题问询
Read the Docs autodoc HTML内容缺失排查方案
- 核查Sphinx配置文件
conf.py的拓展加载逻辑:确认sphinx.ext.autodoc已被加入extensions列表,重点排查是否存在针对Read the Docs环境的条件判断分支(例如if os.environ.get('READTHEDOCS') == 'True'),避免autodoc拓展在RTD构建HTML时未被加载。 - 核对项目
.readthedocs.yaml的安装配置:Read the Docs构建环境默认不会自动安装你的项目包,需要在install步骤明确添加pip install .或对应项目安装命令,否则autodoc在HTML构建阶段无法导入对应模块生成文档片段;PDF构建逻辑和HTML存在差异,可能出现PDF正常生成但HTML无内容的情况。 - 调高RTD构建日志级别排查警告:RTD默认仅展示错误级别的日志,autodoc抛出的模块找不到、指令错误等警告不会导致构建失败,但会造成生成内容为空,你可以在构建配置中将日志级别调整为
WARNING,即可看到这类隐性报错。 - 对比本地HTML构建结果:本地执行
make html命令,检查生成的HTML文件是否包含autodoc生成的内容,如果本地HTML同样缺失对应内容,优先排查rst文件的autodoc指令书写是否正确、模块路径是否准确。 - 核查路径大小写问题:RTD构建环境为Linux系统,区分文件/模块路径大小写,若本地开发环境为Windows或macOS(默认不区分大小写),可能出现本地加载正常、RTD环境下autodoc无法找到对应模块的问题,逐一核对rst文件中autodoc指令的模块路径大小写即可。
内容的提问来源于stack exchange,提问作者Radost Waszkiewicz
相关产品推荐
相关产品推荐

