From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail2-relais-roc.national.inria.fr (mail2-relais-roc.national.inria.fr [192.134.164.83]) by sympa.inria.fr (Postfix) with ESMTPS id C2A527F029 for ; Fri, 30 Sep 2016 11:28:33 +0200 (CEST) Authentication-Results: mail2-smtp-roc.national.inria.fr; spf=None smtp.pra=daniel.buenzli@erratique.ch; spf=None smtp.mailfrom=daniel.buenzli@erratique.ch; spf=None smtp.helo=postmaster@smtp.webfaction.com Received-SPF: None (mail2-smtp-roc.national.inria.fr: no sender authenticity information available from domain of daniel.buenzli@erratique.ch) identity=pra; client-ip=74.55.86.74; receiver=mail2-smtp-roc.national.inria.fr; envelope-from="daniel.buenzli@erratique.ch"; x-sender="daniel.buenzli@erratique.ch"; x-conformance=sidf_compatible Received-SPF: None (mail2-smtp-roc.national.inria.fr: no sender authenticity information available from domain of daniel.buenzli@erratique.ch) identity=mailfrom; client-ip=74.55.86.74; receiver=mail2-smtp-roc.national.inria.fr; envelope-from="daniel.buenzli@erratique.ch"; x-sender="daniel.buenzli@erratique.ch"; x-conformance=sidf_compatible Received-SPF: None (mail2-smtp-roc.national.inria.fr: no sender authenticity information available from domain of postmaster@smtp.webfaction.com) identity=helo; client-ip=74.55.86.74; receiver=mail2-smtp-roc.national.inria.fr; envelope-from="daniel.buenzli@erratique.ch"; x-sender="postmaster@smtp.webfaction.com"; x-conformance=sidf_compatible IronPort-PHdr: =?us-ascii?q?9a23=3A/GUrMh2sPKq5KD0LsmDT+DRfVm0co7zxezQtwd8Z?= =?us-ascii?q?segVKPad9pjvdHbS+e9qxAeQG96KsbQe0qGP7+igATVGusnR9ihaMdRlbFwst4?= =?us-ascii?q?Y/p0QYGsmLCEn2frbBThcRO4B8bmJj5GyxKkNPGczzNBX4q3y26iMOSF2kbVIm?= =?us-ascii?q?bsy8IIPZjty22uau4NWTJlwQ3HvuKY91eTu/px/QvcRepYYqBKsq0RLPvjMcVe?= =?us-ascii?q?1c32JjKBS3kiHy69yr9Zh/2yVWofMoscBaB/bUZaM9GJBRCjUrN1cfcMv5sRiL?= =?us-ascii?q?GQeG4HoRViMcjxdOEQzExBzgRJ7tszLnu6x22H/JboXNUbkoVGH6vO9QQxjyhX?= =?us-ascii?q?JCbmZh/Q=3D=3D?= X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: =?us-ascii?q?A0CkAADSLu5Xf0pWN0pdGwEBAQMBAQEJA?= =?us-ascii?q?QEBFwEBBAEBCgEBgxQBAQEBAXV8AY0xln6UI4IGJIJEgzYCghoUAQEBAQEBAQE?= =?us-ascii?q?BAQESAQEJCwsJFzGCMgQBFQEEghABAQEDASNWBQsLGAICHwcCAkcQBhuIPQgEC?= =?us-ascii?q?rEejG4BAQEBBgEBAQEBIoEGigaHSCuCEh0BBJl4hieMBYceDoYJjG2DfR6EB4E?= =?us-ascii?q?6cAGFMYFBAQEB?= X-IPAS-Result: =?us-ascii?q?A0CkAADSLu5Xf0pWN0pdGwEBAQMBAQEJAQEBFwEBBAEBCgE?= =?us-ascii?q?BgxQBAQEBAXV8AY0xln6UI4IGJIJEgzYCghoUAQEBAQEBAQEBAQESAQEJCwsJF?= =?us-ascii?q?zGCMgQBFQEEghABAQEDASNWBQsLGAICHwcCAkcQBhuIPQgECrEejG4BAQEBBgE?= =?us-ascii?q?BAQEBIoEGigaHSCuCEh0BBJl4hieMBYceDoYJjG2DfR6EB4E6cAGFMYFBAQEB?= X-IronPort-AV: E=Sophos;i="5.31,271,1473112800"; d="scan'208";a="238875991" Received: from mail6.webfaction.com (HELO smtp.webfaction.com) ([74.55.86.74]) by mail2-smtp-roc.national.inria.fr with ESMTP/TLS/DHE-RSA-AES256-SHA; 30 Sep 2016 11:28:31 +0200 Received: from [192.168.5.177] (204-129.dsl.iskon.hr [89.164.204.129]) by smtp.webfaction.com (Postfix) with ESMTP id 4E7A520F21DB; Fri, 30 Sep 2016 09:28:26 +0000 (UTC) Date: Fri, 30 Sep 2016 11:28:24 +0200 From: =?utf-8?Q?Daniel_B=C3=BCnzli?= To: Fabrice Le Fessant Cc: Anil Madhavapeddy , OCaml List , Maxence Guesdon , mirageos-devel Message-ID: <5CA03080E98940728E04BB780F579A0D@erratique.ch> In-Reply-To: References: X-Mailer: sparrow 1.6.4 (build 1178) MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 7bit Content-Disposition: inline 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) 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