使用 odoc 產生文件

文件渲染工具 odoc 從專案模組的 docstring 和介面產生 HTML、LaTeX 或 man page 格式的文件。

Dune 可以在你的專案上運行 odoc，使用這個指令來產生 HTML 文件。

$ opam exec -- dune build @doc

# Unix or macOS
$ open _build/default/_doc/_html/index.html

# Windows
$ explorer _build\default\_doc\_html\index.html

產生 .mld 文件頁面

除了記錄專案的公開 API 之外，odoc 還可以讓您新增個別的文件頁面。

例如，要替換自動產生的文件索引檔案，您必須在您的專案中新增一個 index.mld 檔案。

為了讓 Dune 找到您的 .mld 頁面並使用 odoc 處理它們，與您的 .mld 檔案在同一目錄中的 dune 檔案需要包含以下程式碼片段：

(documentation
 (package name-of-your-package))

放置 .mld 檔案的常見位置是名為 doc 或 docs 的目錄。

有關如何為 odoc 撰寫文件頁面的更多資訊，請參閱odoc 給作者的文件。