Mailing list for all users of the OCaml language and system.
 help / color / mirror / Atom feed
From: Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
To: "Anil Madhavapeddy" <anil@recoil.org>,
	"Daniel Bünzli" <daniel.buenzli@erratique.ch>
Cc: OCaml List <caml-list@inria.fr>,
	Maxence Guesdon <maxence.guesdon@inria.fr>,
	 mirageos-devel <MirageOS-devel@lists.xenproject.org>
Subject: Re: [Caml-list] [MirageOS-devel] [RE-ANN] From opkg to odig v0.0.1 (was Re: [ANN] opkg v0.0.1 - Documentation access improvements)
Date: Fri, 30 Sep 2016 09:00:48 +0000	[thread overview]
Message-ID: <CAHvkLrOA0rJD-tz_iRP542WapMN_6OnUn0_8Mz7ng5s0qVLEGQ@mail.gmail.com> (raw)
In-Reply-To: <F6D2DB0F-F95B-446C-9FF7-3E4031192E4B@recoil.org>

[-- Attachment #1: Type: text/plain, Size: 2458 bytes --]

Hi,

  Looking briefly at the two websites, the differences are not obvious. Could
you describe a little the differences between the two tools ? Is one of
them more precise than the other one ? Is one of them easier to use ?

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

--Fabrice

On Thu, Sep 29, 2016 at 5:14 PM Anil Madhavapeddy <anil@recoil.org> wrote:

> 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
>
>
> --
> Caml-list mailing list.  Subscription management and archives:
> https://sympa.inria.fr/sympa/arc/caml-list
> Beginner's list: http://groups.yahoo.com/group/ocaml_beginners
> Bug reports: http://caml.inria.fr/bin/caml-bugs

[-- Attachment #2: Type: text/html, Size: 4119 bytes --]

  reply	other threads:[~2016-09-30  9:01 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-09-23 19:10 [Caml-list] [ANN] opkg v0.0.1 - Documentation access improvements Daniel Bünzli
2016-09-27 19:34 ` [Caml-list] [RE-ANN] From opkg to odig v0.0.1 (was Re: [ANN] opkg v0.0.1 - Documentation access improvements) Daniel Bünzli
2016-09-29 15:13   ` [Caml-list] [MirageOS-devel] " Anil Madhavapeddy
2016-09-30  9:00     ` Fabrice Le Fessant [this message]
2016-09-30  9:28       ` Daniel Bünzli

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CAHvkLrOA0rJD-tz_iRP542WapMN_6OnUn0_8Mz7ng5s0qVLEGQ@mail.gmail.com \
    --to=fabrice.le_fessant@inria.fr \
    --cc=MirageOS-devel@lists.xenproject.org \
    --cc=anil@recoil.org \
    --cc=caml-list@inria.fr \
    --cc=daniel.buenzli@erratique.ch \
    --cc=maxence.guesdon@inria.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox