How to install

Install with opam

If digodoc is available in your opam repository, you can just call:

opam install digodoc

Build and install with dune

Checkout the sources of digodoc in a directory.

You need a switch with at least version 4.10.0 of OCaml, you can for example create it with:

opam switch create 4.10.0

Then, you need to install all the dependencies:

opam install --deps-only .

Finally, you can build the package and install it:

eval $(opam env)
dune build
dune install

Note that a Makefile is provided, it contains the following targets:

• build: build the code
• install: install the generated files
• build-deps: install opam dependencies
• sphinx: build sphinx documentation (from the sphinx/ directory)
• dev-deps: build development dependencies, in particular ocamlformat, odoc and merlin
• doc: build documentation with odoc
• fmt: format the code using ocamlformat
• test: run tests