OCaml Documentation Generator

odoc is a powerful and flexible documentation generator for OCaml. It reads doc comments, demarcated by (** ... *), and transforms them into a variety of output formats, including HTML, LaTeX, and man pages.

  • Output Formats: Odoc generates HTML for web browsing, LaTeX for PDF generation, and man pages for use on Unix-like systems.
  • Cross-References: odoc uses the ocamldoc markup, which allows to create links for functions, types, modules, and documentation pages.
  • Link to Source Code: Documentation generated includes links to the source code of functions, providing an easy way to navigate from the docs to the actual implementation.
  • Code Highlighting: odoc automatically highlights syntax in code snippets for different languages.

odoc is part of the OCaml Platform, the recommended set of tools for OCaml.

AuthorsAnton Bachin <antonbachin@yahoo.com>, Daniel Bünzli <daniel.buenzli@erratique.ch>, David Sheets <sheets@alum.mit.edu>, Jon Ludlam <jon@recoil.org>, Jules Aguillon <juloo.dsi@gmail.com>, Leo White <leo@lpw25.net>, Lubega Simon <lubegasimon73@gmail.com>, Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com> and Thomas Refis <trefis@janestreet.com>
Issue Trackerhttps://github.com/ocaml/odoc/issues
MaintainersDaniel Bünzli <daniel.buenzli@erratique.ch>, Jon Ludlam <jon@recoil.org>, Jules Aguillon <juloo.dsi@gmail.com> and Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>
Source [http] https://github.com/ocaml/odoc/releases/download/2.4.2/odoc-2.4.2.tbz
Required by