rpms
/
ocaml-odoc
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
45 Commits 11 Branches 0 Tags 131 KiB
RPM Spec 100%
Go to file
Jerry James 3400f290ba Re-enable debuginfo now that dune is fixed 2023-03-21 21:32:37 -06:00
.gitignore Initial import. 2020-01-14 09:17:20 -07:00
README.md Version 2.1.0. 2022-02-09 09:36:31 -07:00
ocaml-odoc.spec Re-enable debuginfo now that dune is fixed 2023-03-21 21:32:37 -06:00
sources Version 2.2.0. Disable tests due to missing dependency. 2023-01-09 12:36:09 -07:00

README.md

ocaml-odoc

This package contains odoc, a documentation generator for OCaml and Reason. It reads doc comments, delimited with (** ... *), and outputs HTML. Text inside doc comments is marked up in ocamldoc syntax.

Odoc's main advantage over ocamldoc is an accurate cross-referencer, which handles the complexity of the OCaml module system. Odoc also offers a good opportunity to improve HTML output compared to ocamldoc, but this is very much a work in progress.