readthedocs构建分支名称含斜杠时运行行为是否存在差异?
Read the Docs 分支渲染与侧边栏异常解决方案
feature/sphinx分支根目录识别异常问题
首先可以明确:分支名包含斜杠不会导致该问题,Read the Docs原生支持Git Flow风格的带斜杠分支命名格式。
该问题的根因是你没有在项目根目录的.readthedocs.yaml配置文件中显式指定文档源码路径,触发了平台默认路径识别的歧义,按以下方式修改配置即可解决:
- 在配置文件中添加
sphinx.configuration字段,指定为docs/source/conf.py - 同时添加
documentation_dir字段,取值为docs/source
修改后将配置同步到两个分支,重新触发构建即可让平台正确识别文档源码根目录。
两个分支侧边栏无法正常渲染的问题
按优先级依次排查以下配置即可定位问题:
- 先本地验证Sphinx配置正确性:在本地执行
sphinx-build docs/source docs/build命令构建文档,查看本地生成的HTML是否正常显示侧边栏和目录- 如果本地也异常:检查
docs/source/conf.py中的配置:- 确认
html_theme已设置为sphinx_rtd_theme,且对应扩展已正确引入 - 确认
html_sidebars配置项未被设置为空,已包含目录渲染相关的模板配置 - 确认首页
index.rst中的toctree指令语法正确,maxdepth参数配置合理,没有添加隐藏属性
- 确认
- 如果本地正常:登录Read the Docs后台,检查两个分支的版本设置,确认没有单独覆盖侧边栏相关的渲染配置,清除缓存后重新构建即可。
- 如果本地也异常:检查
内容的提问来源于stack exchange,提问作者villaa
相关产品推荐
相关产品推荐

