Platform
Overview
Best Practices
Bootstrapping a Project Managing Dependencies With Opam Installing a Specific Compiler Version Running Executables and Tests Creating Libraries Publishing a Package Configuring Your Editor Formatting Your Code Generating Documentation
OCaml Platform
Guiding Principles Users OCaml Platform Roadmap

Generating Documentation With Odoc

The documentation rendering tool odoc generates documentation in the form of HTML, LaTeX, or man pages, from the docstrings and interfaces of the project's modules

Dune can run odoc on your project to generate HTML documentation with this command:

$ dune build @doc

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

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

Help Improve Our Documentation

All OCaml docs are open source. See something that's wrong or unclear? Submit a pull request.

Contribute

Still need help?

Ask the OCaml Community
Open an Issue