sphinx_rtd_theme 3.0版本重大变更:版本选择器功能迁移指南
2025-06-10 12:10: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扩展
- 全面测试各版本间的切换功能
这一架构调整虽然带来了短暂的迁移成本,但从长远看将使文档系统更加模块化和可维护。开发团队将持续优化用户体验,确保过渡过程尽可能平滑。
登录后查看全文
热门项目推荐
相关项目推荐
AutoGLM-Phone-9BAutoGLM-Phone-9B是基于AutoGLM构建的移动智能助手框架,依托多模态感知理解手机屏幕并执行自动化操作。Jinja00
Kimi-K2-ThinkingKimi K2 Thinking 是最新、性能最强的开源思维模型。从 Kimi K2 开始,我们将其打造为能够逐步推理并动态调用工具的思维智能体。通过显著提升多步推理深度,并在 200–300 次连续调用中保持稳定的工具使用能力,它在 Humanity's Last Exam (HLE)、BrowseComp 等基准测试中树立了新的技术标杆。同时,K2 Thinking 是原生 INT4 量化模型,具备 256k 上下文窗口,实现了推理延迟和 GPU 内存占用的无损降低。Python00
GLM-4.6V-FP8GLM-4.6V-FP8是GLM-V系列开源模型,支持128K上下文窗口,融合原生多模态函数调用能力,实现从视觉感知到执行的闭环。具备文档理解、图文生成、前端重构等功能,适用于云集群与本地部署,在同类参数规模中视觉理解性能领先。Jinja00
HunyuanOCRHunyuanOCR 是基于混元原生多模态架构打造的领先端到端 OCR 专家级视觉语言模型。它采用仅 10 亿参数的轻量化设计,在业界多项基准测试中取得了当前最佳性能。该模型不仅精通复杂多语言文档解析,还在文本检测与识别、开放域信息抽取、视频字幕提取及图片翻译等实际应用场景中表现卓越。00
GLM-ASR-Nano-2512GLM-ASR-Nano-2512 是一款稳健的开源语音识别模型,参数规模为 15 亿。该模型专为应对真实场景的复杂性而设计,在保持紧凑体量的同时,多项基准测试表现优于 OpenAI Whisper V3。Python00
GLM-TTSGLM-TTS 是一款基于大语言模型的高质量文本转语音(TTS)合成系统,支持零样本语音克隆和流式推理。该系统采用两阶段架构,结合了用于语音 token 生成的大语言模型(LLM)和用于波形合成的流匹配(Flow Matching)模型。 通过引入多奖励强化学习框架,GLM-TTS 显著提升了合成语音的表现力,相比传统 TTS 系统实现了更自然的情感控制。Python00
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
项目优选
收起
deepin linux kernel
C
24
9
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
402
3.12 K
Ascend Extension for PyTorch
Python
224
249
暂无简介
Dart
672
159
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
663
315
React Native鸿蒙化仓库
JavaScript
262
324
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.2 K
655
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
64
19
openGauss kernel ~ openGauss is an open source relational database management system
C++
160
219