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

[Anil Madhavapeddy <anil@recoil.org>]

Dear all,

I have deployed an experimental documentation build for MirageOS libraries (and dependencies thereof) using odig at:

http://docs.mirage.io

an experimental build using odoc (the new cross-referencing tool that is still being worked on, so expected rendering bugs) is available under:

http://docs.mirage.io/odoc/

These URLs are all subject to change, but I thought it might be useful to see the generated output for a real project.  The Dockerfile that generates this site is at: https://github.com/mirage/mirage/blob/master/Dockerfile.doc

regards,
Anil

> On 27 Sep 2016, at 20:34, Daniel Bünzli <daniel.buenzli@erratique.ch> wrote:
> 
> Hello,
> 
> Due to concerns over a binary name clash with OpenWRT's package manager [1], the opkg project  
> was renamed to odig.
> 
>  http://erratique.ch/software/odig
> 
> If you have installed opkg the way out is:
> 
> opkg cache clear
> opam remove opkg  
> opam update && opam install odig
> odig ocamldoc  
> odig doc  
> 
> Thanks to David Kaloper Meršinjak and Peter Zotov for raising
> the issue.  
> 
> Sorry for the inconvenience and happy doc digging,
> 
> Daniel
> 
> P.S. To package devs if there are issues with the way your docs get rendered please get in touch on the issue tracker (if that's not due to your package install or an ocamldoc issue itself).  
> 
> [1] https://wiki.openwrt.org/doc/techref/opkg
> 
> _______________________________________________
> MirageOS-devel mailing list
> MirageOS-devel@lists.xenproject.org
> https://lists.xenproject.org/cgi-bin/mailman/listinfo/mirageos-devel