在本地生成参考文档

fuchsia.dev 的大多数参考文档都是通过调用 docsgen 工具的基础架构方案生成的。

docsgen 工具会调用用于生成参考文档的各种其他工具,例如:

基础架构配方生成此文档后,便会将其推送到 reference-docs 代码库

然后,文档会发布到 fuchsia.dev 的参考部分(即 fuchsia.dev/reference/)。

还有手动创建的参考文档,通常会发布到前缀为 fuchsia.dev/fuchsia-src/reference/ 的网址。本文档的来源位于 //docs/reference/

在本地生成参考文档

在某些情况下,在本地运行 docsgen 以查看生成文档的各种工具的输出会很有用。

如需在本地运行 docsgen,请执行以下操作:

  1. fx set 中添加了 docsgen。例如,您可以使用 minimal 配置:

    fx set minimal.x64 --with //tools/docsgen
  2. 构建并运行 docsgen

    fx build tools/docsgen

    然后,您可以在 Fuchsia 检出目录的 //out/default/obj/docsgen 中查看已构建的参考文档。