大多數 fuchsia.dev 參考文件都是透過呼叫 docsgen
工具的基礎結構食譜產生。
docsgen
工具會呼叫各種其他工具,產生參考文件,例如:
- bazel-docgen
- Clidoc
- 由 cmc 產生的 CMLdoc
- Driversdoc
- FIDLdoc
- fx helpdoc
- 為 Zircon 系統呼叫建立動作
基礎架構食譜產生這份文件後,就會推送至 reference-docs
存放區。
接著,文件會發布至 fuchsia.dev 的參考資料部分,也就是 fuchsia.dev/reference/。
您也可以手動建立參考文件,通常會發布至前置字串為 fuchsia.dev/fuchsia-src/reference/
的網址。這份說明文件的來源位於 //docs/reference/
。
在本機產生參考說明文件
在某些情況下,您可以將 docsgen
本機執行,藉此查看產生文件的各種工具輸出內容。
如何在本機執行 docsgen
:
在
fx set
中新增docsgen
。例如,您可以使用minimal
設定:fx set minimal.x64 --with //tools/docsgen
建構及執行
docsgen
:fx build tools/docsgen
接著,您可以查看 Fuchsia 結帳資料夾中的
//out/default/obj/docsgen
中建構的參考文件。