使用 odoc 生成文档

文档渲染工具 odoc 使用项目模块的文档字符串和接口，生成 HTML、LaTeX 或手册页形式的文档

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 作者文档.