文档架构¶
文档依赖于 Sphinx 和许多 Sphinx 扩展。
文档代码位于两个主要目录中
我们的文档支持 rst 和 markdown 语法。
配置¶
主配置文件为
https://searchfox.org/mozilla-central/source/docs/config.yml
它包含类别、重定向、警告和其他配置方面。
依赖项列在
https://searchfox.org/mozilla-central/source/tools/moztreedocs/requirements.in
请注意，存储在 third_party/python 中的 Python 库将优先使用（并非总是出于正当理由）。有关更多详细信息，请参阅 将 Python 包的源代码引入树中。
架构¶
mach doc 参数管理
环境检测/配置（nodejs 用于 jsdoc，pip 用于依赖项等）
将文档源文件 (.rst & .md) 从源代码树符号链接到暂存目录
如果识别出任何严重警告，则构建失败
启动 sphinx 构建（如果设置了选项，则提供服务）
管理遥测
docs/conf.py 定义
扩展列表
JS 源代码路径
各种 sphinx 配置
在构建文档过程结束时，文件将上传到 CDN
https://searchfox.org/mozilla-central/source/tools/moztreedocs/upload.py