dsheets / codoc

OCaml documentation generator
34 stars 5 forks source link

Installation question: reinstall other packages? #97

Open mars0i opened 7 years ago

mars0i commented 7 years ago

As I understand the current installation instructions, codoc will only work with a new compiler switch and will only work with packages installed after codoc is installed. Is this correct?

So if I have an existing opam installation, I would have to uninstall any package for which I wanted to be able to generate documentation. Or maybe it would be easiest to simply remove .opam and reinstall everything--takes a few minutes, but it's an easy fix.

(Would be helpful to make a dependency of each ocaml release.? That way, codoc will always be installed first. After all, who doesn't want documentation, or at least the option to generate it?)

Thanks.

dbuenzli commented 7 years ago

I don't want to talk for @dsheets but I'm pretty sure he won't mind.

codoc was an iteration of what has now become odoc which is developed here.

One way of using odoc on your switch is to use odig (it will give something like this). The current released version of odig uses ocamldoc as the default backend and I'm not sure it works with the released odoc. If you want documentation for a switch I'd suggest you try this:

opam install odoc 
opam pin add --dev odig 
odig odoc 
odig doc
mars0i commented 7 years ago

Thanks dbuenzli. I can try odoc. (I tried to install odig through opam recently but got an error that didn't seem informative in any obvious way. Since the README says that it's a work in progress, I thought that maybe I should just wait until another release, but I can submit an issue if that might be helpful at this point.)

dbuenzli commented 7 years ago

but I can submit an issue if that might be helpful at this point.)

Please do.