Sphinx sphinx_rtd_theme主题左侧导航栏点击后自动折叠问题
Sphinx RTD主题侧边栏跳转后全折叠问题修复
该问题由主题默认配置与嵌套toctree参数不匹配导致,按以下步骤操作即可修复:
- 调整
conf.py中的主题配置参数
找到html主题配置段,添加/修改如下配置项:
其中html_theme_options = { # 关闭导航默认强制折叠 'collapse_navigation': False, # 导航识别深度要大于实际文档嵌套层级 'navigation_depth': 4, # 固定侧边栏滚动位置 'sticky_navigation': True }collapse_navigation默认值为True,每次页面跳转都会自动折叠所有非顶级节点,是触发全折叠问题的核心原因。 - 修正toctree层级参数冲突
根目录index.rst中顶级toctree的:maxdepth: 2参数,和子页面sphnix_toolbox.testing.rst内嵌套的二级toctree存在层级限制冲突,会导致主题无法识别当前页面对应的父级菜单,跳转时丢失展开状态。将顶级toctree的maxdepth调整为3即可,和主题的navigation_depth参数匹配:.. toctree:: :maxdepth: 3 :titlesonly: sphnix_toolbox.testing ... - 清理缓存重新构建
配置修改完成后,删除旧构建生成的_build目录,重新执行make html命令编译文档即可。必须清理旧缓存,否则新配置不会生效,会出现修改后折叠问题依旧的情况。
额外检查:当前配置中多次出现的
sphnix为拼写错误,正确拼写应为sphinx,若文件名、toctree引用名拼写不匹配,也会导致导航关联失效,建议同步修正。
内容的提问来源于stack exchange,提问作者300
相关产品推荐
相关产品推荐

