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扩展
- 全面测试各版本间的切换功能
这一架构调整虽然带来了短暂的迁移成本,但从长远看将使文档系统更加模块化和可维护。开发团队将持续优化用户体验,确保过渡过程尽可能平滑。
登录后查看全文
热门项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0191
cann-learning-hubCANN 学习中心仓,支持在线互动运行、边学边练,提供教程、示例与优化方案,一站式助力昇腾开发者快速上手。Jupyter Notebook0117
Step-3.7-FlashStep-3.7-Flash是一个拥有 1980 亿参数的稀疏混合专家(MoE)视觉语言模型,由 1960 亿参数的语言主干网络和 18 亿参数的视觉编码器组合而成,具备原生图像理解能力。Python00
JoyAI-EchoJoyAI-Echo,这是一个独立的、仅用于推理的版本,旨在实现分钟级多镜头音视频生成。它采用了经过蒸馏的DMD生成器、配对的跨模态记忆以及故事级别的一致性。其性能的核心在于,一个跨模态视听记忆库能够在长达五分钟的视频中保持角色外观和语音音色的一致性。同时,一个训练后处理流程将基于记忆的强化学习与分布匹配蒸馏相结合,实现了7.5倍的速度提升,显著增强了视觉质量和对齐效果。00
fun-rec推荐系统入门教程,在线阅读地址:https://datawhalechina.github.io/fun-rec/Python03
so-large-lm大模型基础: 一文了解大模型基础知识01
项目优选
收起
暂无描述
Dockerfile
764
4.97 K
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。
C++
857
1.92 K
本项目是CANN提供的神经网络类计算算子库,实现网络在NPU上加速计算。
C++
680
1.33 K
Ascend Extension for PyTorch
Python
719
875
deepin linux kernel
C
32
16
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
456
438
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1.08 K
1.1 K
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
150
252
CANN 学习中心仓,支持在线互动运行、边学边练,提供教程、示例与优化方案,一站式助力昇腾开发者快速上手。
Jupyter Notebook
303
117
昇腾LLM分布式训练框架
Python
178
220