Debian OCaml Packaging Policy for OCaml 3.10.2
Prev | Chapter 3. Packaging OCaml libraries | Next

# 3.6. Documentation

The documentation is a joint effort of The Debian OCaml Task Force and usptream. There are many ways to have documentation:

- header files (`*.mli`),

- source files (`*.ml`),

- specific documentation provided by the upstream,

- OCamldoc generated documentation.

This documentation should be browsable by different mean, from the most simple to the most complex. At least, they should all be readable with simple text editor. Specific and ocamldoc generated documentations should be provided in HTML format. There are also at least two specific OCaml browser : docbrowse shipped with cameleon and ocamlbrowser shipped with OCaml itself. The first one, needs specific ocamldoc generated documentation. The second one enables the user to browse directly the prototype of each function shipped in the `cmi` gives to the application.

You can generate ocamldoc-specific documentation by using the `-dump` of this application. By using this, you dump the intermediary representation of the document that will be generated by ocamldoc. This can be used to generate HTML documentation and manpages, by reloading this file (using `-load`).

As of today, there is no way to post-process ocamldoc specific documentation. A Debian package is under construction to do this task. It will be referred as ocamldoc-base.

Prev | Home | Next
Camlp4/Camlp5 | Up | The OCaml CDBS class