From: "Daniel Bünzli" <daniel.buenzli@erratique.ch>
To: Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
Cc: Anil Madhavapeddy <anil@recoil.org>,
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 11:28:24 +0200 [thread overview]
Message-ID: <5CA03080E98940728E04BB780F579A0D@erratique.ch> (raw)
In-Reply-To: <CAHvkLrOA0rJD-tz_iRP542WapMN_6OnUn0_8Mz7ng5s0qVLEGQ@mail.gmail.com>
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/).
Best,
Daniel
prev parent reply other threads:[~2016-09-30 9:28 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
2016-09-30 9:28 ` Daniel Bünzli [this message]
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=5CA03080E98940728E04BB780F579A0D@erratique.ch \
--to=daniel.buenzli@erratique.ch \
--cc=Fabrice.Le_fessant@inria.fr \
--cc=MirageOS-devel@lists.xenproject.org \
--cc=anil@recoil.org \
--cc=caml-list@inria.fr \
--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;
as well as URLs for NNTP newsgroup(s).