[opam-devel] opam-doc

[Thomas Gazagnaire]

Hi all,

I've tried to simplify the use of Leo's opam-doc and I came up with a pretty simple workflow.

1. install opam-doc: 

git clone git at github.com:samoht/opam-doc.git
cd opam-doc
opam install cow && make && make install

This will create a `doc` switch with the right compiler wrappers, and it will install opam-doc-* scripts in your current switch.

2. build the documentation

opam doc PKG1 ... PKGn

this will install the various packages in the `doc` switch, call the various scripts to install the cmd files at the right place and generate the HTML pages and so on. Finally, it will serve the contents of ~/.opam/doc/doc on http://127.0.0.1:8000 than you can then browse locally (using python -m SimpleHTTPServer).

This is still a very preliminary work (I'd love to replace the bunch of scripts by a proper OCaml program -- to easily change host port/name for instance) but I'd gladly welcome your feedback.

Best,
Thomas