Sphinx v8.1.3搭配sphinx_rtd_theme不显示版本问题咨询
Sphinx 8.1.3 + sphinx_rtd_theme 版本信息显示方案
新版 sphinx_rtd_theme 确实不再默认在搜索栏上方展示 version/release 参数内容,你可以通过以下两种方式实现版本显示:
方法一:配置主题参数
在项目的 conf.py 中添加主题配置,直接开启版本显示功能:
html_theme_options = { 'display_version': True, }
同时确保已正确配置版本参数:
version = '1.0' # 短版本标识 release = '1.0.0' # 完整版本号
配置后主题会在页面头部合适位置自动展示版本信息。
方法二:自定义模板(方法一失效时使用)
如果主题参数配置无效果,可通过自定义 layout.html 实现:
- 在项目的
_templates目录下新建layout.html(无此目录则手动创建) - 复制 sphinx_rtd_theme 原模板的
layout.html内容,在搜索栏上方的位置插入版本显示代码:
<div style="margin: 0 0 10px;">当前版本:{{ release }}</div>
也可使用短版本号变量 {{ version }},还可以通过自定义 CSS 调整该元素的样式与位置。
内容的提问来源于stack exchange,提问作者Roure Ossò
相关产品推荐
相关产品推荐

