Skip to content
/ odoc Public
forked from ocaml/odoc

Documentation compiler for OCaml and Reason

License

Notifications You must be signed in to change notification settings

ejmg/odoc

 
 

Repository files navigation

odoc   OCaml-CI Build Status Coverage Status

odoc is a documentation generator for OCaml. It reads doc comments , delimited with (** ... *), and outputs HTML, LaTeX and man pages.

Using odoc with OCaml

To install odoc with opam:

$ opam install odoc

For more information, see the odoc website or build the docs locally yourself from the odoc directory:

git clone https://github.com/ocaml/odoc.git
cd odoc
opam pin add . -n
opam install mdx bos
opam install --deps-only -t odoc
dune build @docgen

and find the docs in _build/default/doc/html/index.html

Contact

odoc is most discussed on discuss.ocaml.org's Ecosystem category with the odoc tag. Please also don't hesitate to open an issue.


Contributing

Any question asked, issue opened, feedback offered, is a contribution to odoc, and the project and all its users are thankful :) If you'd like to contribute code specifically, you may find the guide in doc/contributing.mld helpful.

About

Documentation compiler for OCaml and Reason

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • OCaml 44.4%
  • HTML 25.6%
  • TeX 10.1%
  • Standard ML 7.1%
  • SourcePawn 5.3%
  • Roff 3.8%
  • Other 3.7%