codoc icon indicating copy to clipboard operation
codoc copied to clipboard

About packages

Open Drup opened this issue 10 years ago • 2 comments
trafficstars

The documentation is very unclear about what codoc's packages are. For a while, I was very confused because I was trying things like that: codoc doc --package llvmgraph -o doc-llvmgraph ~/.opam/4.02.1+doc/build/ believing that codoc would figure out that I want the llvmgraph (opam or ocamlfind) package and it's transitive dependencies only.

Seeing it wasn't working as expected, and since the documentation was talking about path, I tried to put the path to llvmgraph there (~/.opam/4.02.1+doc/build/llvmgraph.dev). codoc raise a stack overflow in this case. :$

I finally got it by looking at the code of opam doc.

Drup avatar Apr 04 '15 01:04 Drup

Thanks for reporting this constellation of issues. Do you have an idea for better terminology?

I will address the documentation and overflow issues soon.

dsheets avatar Apr 07 '15 10:04 dsheets

I'm not really sure. Fundamentally, If I understand correctly, we first have a tree where the documentation indexes are the leaves, right ? Maybe describing in term of path to the documentation index is better ? I'm not really convinced either.

Maybe package is fine, you just need to give an example.

Drup avatar Apr 07 '15 12:04 Drup