sphinx_rtd_theme 3.0版本重大变更:版本选择器功能迁移指南
2025-06-10 13:30:23作者:谭伦延
sphinx_rtd_theme作为Python文档生成工具Sphinx的流行主题,在3.0.0rc1版本中引入了一项重要变更:移除了内置的版本选择器功能。这一变更反映了Read the Docs平台向更现代化的文档构建方式的演进。
变更背景与技术考量
3.0版本的主要变更源于Read the Docs平台决定将"Addons"功能设为默认启用。Addons是平台提供的一组增强功能,包括版本选择器、搜索优化等。这一架构调整带来了以下优势:
- 功能解耦:将版本控制等平台相关功能从主题中分离,使主题更专注于样式和布局
- 动态更新:Addons提供的功能可以独立于文档构建过程更新
- 统一体验:所有Read the Docs项目将获得一致的功能实现
迁移方案详解
对于需要保留版本选择器的项目,目前提供两种实现方案:
方案一:使用Read the Docs Addons(推荐)
- 在项目设置中启用Addons功能
- 保持"Flyout enabled"选项为选中状态
- 无需重建文档,版本选择器将自动显示在页面右下角
此方案的优势在于无需代码变更,且能获得平台提供的最新功能。
方案二:使用主题内置选择器
- 在项目设置中启用Addons功能
- 取消选中"Flyout enabled"选项
- 在conf.py中添加配置:
flyout_display = "attached" - 重新构建文档,版本选择器将显示在导航栏左下角
注意:使用此方案需确保正确安装主题作为Sphinx扩展,否则可能因缺少jQuery依赖导致功能异常。
未来发展方向
开发团队计划进一步优化版本和语言选择器的集成方式,参考Python官方文档的实现:
- 将选择器组件拆分为独立元素
- 更自然地集成到主题布局中
- 提供更灵活的定制选项
版本发布计划
3.0.0正式版计划于10月7日发布,与Read the Docs平台Addons默认启用的时间点保持一致。在此之前,团队将通过rc版本收集用户反馈并完善功能。
最佳实践建议
对于新项目,建议直接采用方案一(Addons实现)。对于现有项目迁移:
- 测试环境先行验证
- 更新构建依赖至最新版本
- 检查主题是否正确配置为Sphinx扩展
- 全面测试各版本间的切换功能
这一架构调整虽然带来了短暂的迁移成本,但从长远看将使文档系统更加模块化和可维护。开发团队将持续优化用户体验,确保过渡过程尽可能平滑。
登录后查看全文
热门项目推荐
相关项目推荐
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C098
baihu-dataset异构数据集“白虎”正式开源——首批开放10w+条真实机器人动作数据,构建具身智能标准化训练基座。00
mindquantumMindQuantum is a general software library supporting the development of applications for quantum computation.Python058
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
AgentCPM-Explore没有万亿参数的算力堆砌,没有百万级数据的暴力灌入,清华大学自然语言处理实验室、中国人民大学、面壁智能与 OpenBMB 开源社区联合研发的 AgentCPM-Explore 智能体模型基于仅 4B 参数的模型,在深度探索类任务上取得同尺寸模型 SOTA、越级赶上甚至超越 8B 级 SOTA 模型、比肩部分 30B 级以上和闭源大模型的效果,真正让大模型的长程任务处理能力有望部署于端侧。Jinja00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
477
3.56 K
React Native鸿蒙化仓库
JavaScript
287
340
暂无简介
Dart
728
175
Ascend Extension for PyTorch
Python
287
320
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
849
446
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
235
98
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
10
1
TorchAir 支持用户基于PyTorch框架和torch_npu插件在昇腾NPU上使用图模式进行推理。
Python
450
180
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.28 K
705