Read the Docs项目中的Addons功能文档规划
2025-05-28 21:38:05作者:董宙帆
Read the Docs作为开源文档托管平台,正在对其Addons功能进行文档化工作。Addons是平台提供的各种增强功能模块,能够为文档维护者和读者提供更好的体验。
文档结构规划
技术团队决定采用分层文档结构,将各个Addon功能分散到最相关的文档章节中,同时新增一个Addons概览页面:
- 
核心功能文档:每个Addon将被归类到最匹配的功能区域 - 主要面向文档维护者编写
- 高级JS/JSON配置将放在最后处理
 
- 
Addons概览页:集中展示所有Addon的列表和简要描述 - 包含Addon的启用配置说明
- 注明默认启用的Addon
 
功能模块归类方案
根据功能特性,各Addon将被归类到以下文档章节:
- 分析类:Analytics功能归入"托管文档"章节
- 构建流程类:DocDiff和PR通知功能归入"构建过程(PR预览)"子章节
- 阅读体验类:
- Version flyout(版本浮动菜单)
- 非稳定版本通知
- 最新版本通知
- 实时搜索(Search as you type)
- 赞助商展示
 
文档重构计划
在编写Addons文档的同时,团队将对以下现有页面进行重构:
- 版本浮动菜单文档:将被新的Version flyout Addon文档取代
- 版本警告文档:将被非稳定版本通知Addon整合
- 服务端搜索文档:将被实时搜索Addon替代
这种文档结构调整将使Read the Docs的功能说明更加模块化和清晰,方便用户快速找到所需信息,同时保持文档结构的逻辑性和一致性。技术团队将采用渐进式文档更新策略,确保用户在过渡期间仍能获取所需信息。
登录后查看全文 
热门项目推荐
相关项目推荐
 PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00 PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
- DDeepSeek-OCR暂无简介Python00
 openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00 openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
 HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00 HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
 AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03 AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
 Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00 Spark-Scilit-X1-13BFLYTEK Spark Scilit-X1-13B is based on the latest generation of iFLYTEK Foundation Model, and has been trained on multiple core tasks derived from scientific literature. As a large language model tailored for academic research scenarios, it has shown excellent performance in Paper Assisted Reading, Academic Translation, English Polishing, and Review Generation, aiming to provide efficient and accurate intelligent assistance for researchers, faculty members, and students.Python00
 GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00 GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00
- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile013
 Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00 Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起
 docs
docsOpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
247
2.45 K
 kernel
kerneldeepin linux kernel
C
24
6
 cangjie_compiler
cangjie_compiler仓颉编译器源码及 cjdb 调试工具。
C++
116
89
 ohos_react_native
ohos_react_nativeReact Native鸿蒙化仓库
JavaScript
217
297
 flutter_flutter
flutter_flutter暂无简介
Dart
546
119
 RuoYi-Vue3
RuoYi-Vue3🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.01 K
595
 openHiTLS
openHiTLS旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
409
 pytorch
pytorchAscend Extension for PyTorch
Python
85
118
 cangjie_runtime
cangjie_runtime仓颉编程语言运行时与标准库。
Cangjie
124
102
 ops-math
ops-math本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
592
121