首页
/ Read the Docs主题2.1.0版本中版本选择器的兼容性调整

Read the Docs主题2.1.0版本中版本选择器的兼容性调整

2025-05-28 06:50:21作者:彭桢灵Jeremy

Read the Docs作为主流的文档托管平台,其默认主题sphinx_rtd_theme在2.1.0版本迭代中引入了一项重要变更:对版本选择器显示逻辑的调整。这项变更与平台正在推进的"Addons"功能迁移计划密切相关。

在技术实现层面,2.1.0rc1版本的主题默认移除了传统的底部左侧版本选择器,这是平台向新交互模式过渡的阶段性设计。开发团队在后续的2.1.0rc2版本中通过引入flyout_display配置项提供了更灵活的显示控制方案。

对于使用者而言,需要注意以下关键点:

  1. 当使用2.1.0rc1版本主题时,必须启用平台的Addons功能才能恢复版本选择器的显示。这是因为新版将版本控制功能逐步迁移至Addons体系。

  2. 2.1.0rc2版本通过新增的flyout_display配置参数解决了双重显示问题。该参数支持以下模式:

    • hidden:默认值,隐藏主题内置的版本选择器
    • visible:显示主题内置版本选择器
    • addons-only:仅显示Addons提供的版本选择器
  3. 对于需要保持原有交互体验的项目,建议采用2.0.0稳定版主题,或升级至2.1.0rc2版本后明确配置显示偏好。

这项变更反映了Read the Docs平台架构演进的趋势,将核心功能逐步模块化为可插拔的Addons组件。开发者在版本升级时应当注意测试版本选择功能的兼容性,特别是对于需要多版本维护的技术文档项目。平台方推荐用户及时升级到包含完整配置选项的2.1.0rc2版本,以获得最佳的可控性和兼容性保障。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
165
2.05 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
954
563
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
60
16
apintoapinto
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
0
giteagitea
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
17
0
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
408
387
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Python
77
71
rainbondrainbond
无需学习 Kubernetes 的容器平台,在 Kubernetes 上构建、部署、组装和管理应用,无需 K8s 专业知识,全流程图形化管理
Go
14
1