[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [MirageOS-devel] [Caml-list] [RE-ANN] From opkg to odig v0.0.1 (was Re: [ANN] opkg v0.0.1 - Documentation access improvements)

On Friday 30 September 2016 at 11:00, Fabrice Le Fessant wrote:
> Looking briefly at the two websites, the differences are not obvious.

The main difference is that with odoc, identifiers are linked across packages, 
it also should also work correctly on functor heavy code bases where ocamldoc 
easily starts overwriting its own outputs. Another difference is that rendering 
in odoc is not as good at the moment, the markup output needs reworking and 
some elements that should be links are not linked which poses doc usability 
problem and is reason why odoc is not the default doc path in odig yet.

> FWIW, `ocp-browser` can also be used to browse the API/documentation of 
> installed packages in a terminal: see a screenshot at 
> https://www.typerex.org/ocp-index.html#ocp-browser
Note that `odig` not only gives you access to API docs, it also gives you easy 
access to the readme, changelogs, homepage, issues, etc. of packages. But it 
shouldn't be too hard for `ocp-browser` to align on the conventions established 
by odig, see `odig help packaging`, you could even use the Odig API (unstable 
though, http://erratique.ch/software/odig/doc/).



MirageOS-devel mailing list



Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.