嵌套文档树

此功能本质上意味着我们现在可以将相关的文档分组到共同的“着陆页”下。这将使我们能够将文档重构为更有意义的结构。例如,我们可以为描述 Gecko 内部结构的文档创建一个着陆页,并为描述 mozilla-central 中开发人员工作流程的文档创建另一个着陆页。

澄清几点

  1. SPHINX_TREES 中指定的路径不需要对应于 mozilla-central 中的路径。例如,我可以使用 SPHINX_TREES[“/foo”] = “docs” 注册我的文档,这将使该文档树可以在 firefox-source-docs.mozilla.org/foo 访问。

  2. 嵌套在另一个索引下的任何子树将自动从主索引中隐藏。这意味着您应该确保从某个着陆页链接到任何子树。因此,鉴于我之前在 /foo 处的文档树,如果我现在创建了一个子树并使用 SPHINX_TREES[“/foo/bar”] = “docs” 注册它,则这些文档将不会显示在主索引中。

  3. 子树与其父级之间的关系不一定与其在文件系统上的关系有任何关联。例如,位于 /devtools 下的文档树可以嵌套在位于 /browser 下的索引下。