From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail3-relais-sop.national.inria.fr (mail3-relais-sop.national.inria.fr [192.134.164.104]) by sympa.inria.fr (Postfix) with ESMTPS id 0C62D7ED11 for ; Fri, 23 Sep 2016 21:11:34 +0200 (CEST) Authentication-Results: mail3-smtp-sop.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 (mail3-smtp-sop.national.inria.fr: no sender authenticity information available from domain of daniel.buenzli@erratique.ch) identity=pra; client-ip=74.55.86.74; receiver=mail3-smtp-sop.national.inria.fr; envelope-from="daniel.buenzli@erratique.ch"; x-sender="daniel.buenzli@erratique.ch"; x-conformance=sidf_compatible Received-SPF: None (mail3-smtp-sop.national.inria.fr: no sender authenticity information available from domain of daniel.buenzli@erratique.ch) identity=mailfrom; client-ip=74.55.86.74; receiver=mail3-smtp-sop.national.inria.fr; envelope-from="daniel.buenzli@erratique.ch"; x-sender="daniel.buenzli@erratique.ch"; x-conformance=sidf_compatible Received-SPF: None (mail3-smtp-sop.national.inria.fr: no sender authenticity information available from domain of postmaster@smtp.webfaction.com) identity=helo; client-ip=74.55.86.74; receiver=mail3-smtp-sop.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=3ASR41fRErG6sZvZarEuYGx51GYnF86YWxBRYc798d?= =?us-ascii?q?s5kLTJ75oMqwAkXT6L1XgUPTWs2DsrQf2rCQ6/+rADZRqb+681k6OKRWUBEEjc?= =?us-ascii?q?hE1ycBO+WiTXPBEfjxciYhF95DXlI2t1uyMExSBdqsLwaK+i760zceF13FOBZv?= =?us-ascii?q?IaytQ8iJ3p7xj7/5oseCKyxzxxOFKYtoKxu3qQiD/uI3uqBFbpgL9x3Sv3FTcP?= =?us-ascii?q?5Xz247bXianhL7+9vitMU7q3cYk7sb+sVBSaT3ebgjBfwdVWx+cjN92Mq+kjLK?= =?us-ascii?q?SA/HwnoHTi1CmRNNB03B7Qrmdpb3qCrz8ORnjnq0J8rzGJw9XzWv65BB3Bn6jC?= =?us-ascii?q?ZPYzIw9mDajop6ka9dshagjxFl2YfIYZiIObx1fvWOLpshWWNdU5MJBGR6CYSm?= =?us-ascii?q?Yt5KVrJZMA=3D=3D?= X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: =?us-ascii?q?A0CQAABpfeVXh0pWN0pdHBgNBAEBARUBA?= =?us-ascii?q?QEGAQMBAQGCfgEBAQEBdaYlk1KCBCCCSIM2gh4UAQEBAQEBAQEBAQESAQEBCA0?= =?us-ascii?q?JCRkvgjIEARUBBII6VjUCJgJJFhuIQwQKsEuMVgELJYEGkU0rghIdBZl2hieLf?= =?us-ascii?q?YccDoYDApBnHoNggV2HA4FAAQEB?= X-IPAS-Result: =?us-ascii?q?A0CQAABpfeVXh0pWN0pdHBgNBAEBARUBAQEGAQMBAQGCfgE?= =?us-ascii?q?BAQEBdaYlk1KCBCCCSIM2gh4UAQEBAQEBAQEBAQESAQEBCA0JCRkvgjIEARUBB?= =?us-ascii?q?II6VjUCJgJJFhuIQwQKsEuMVgELJYEGkU0rghIdBZl2hieLfYccDoYDApBnHoN?= =?us-ascii?q?ggV2HA4FAAQEB?= X-IronPort-AV: E=Sophos;i="5.30,383,1470693600"; d="scan'208";a="194471295" Received: from mail6.webfaction.com (HELO smtp.webfaction.com) ([74.55.86.74]) by mail3-smtp-sop.national.inria.fr with ESMTP/TLS/DHE-RSA-AES256-SHA; 23 Sep 2016 21:11:32 +0200 Received: from [192.168.5.177] (141-136-226-151.dsl.iskon.hr [141.136.226.151]) by smtp.webfaction.com (Postfix) with ESMTP id 16B722125009; Fri, 23 Sep 2016 19:10:27 +0000 (UTC) Date: Fri, 23 Sep 2016 21:10:25 +0200 From: =?utf-8?Q?Daniel_B=C3=BCnzli?= To: OCaml List Cc: Maxence Guesdon , mirageos-devel Message-ID: 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: [Caml-list] [ANN] opkg v0.0.1 - Documentation access improvements Hello, One of the goal of the `opkg` project [0] is to kill the myth that documentation doesn't exist in the OCaml eco-system. The fact is that documentation exists in many cases; it's only scattered and thus painful to access. A first version of `opkg` was released just to address this problem. Among other things like swift access to installed change logs, it uses ocamldoc to generate best-effort, per package, API docsets, relying on the mlis and cmis installed by packages. In a >= 4.03 switch, simply invoke : opam install ocaml-manual opkg opkg ocamldoc opkg doc Future `opkg` releases will rely on `cmti` files and use the maturing `odoc` effort [1] for generating API docsets. This will notably add inter-package cross-references. If the packages you use comply with opkg's install conventions, there are a few other commands that you will find useful, here applied to the bos package which satisfies them: opkg doc bos # Show generated API docs opkg changes bos # Show release notes opkg issues bos # Browse issues opkg homepage bos # Browse homepage opkg online-doc bos # Browse online docs More information can be found in `opkg help basics`. Information on packaging conventions is in `opkg help packaging`. Note that these conventions are automatically enforced without having anything special to do if you use `topkg` [2] to release your packages. Finally note that `opkg` is mostly a dumb command driver. All the hard work of API doc generation is being done by ocamldoc and credits should go to Maxence Guesdon for all the work he put in it over the years. Best & RTFM, Daniel [0] http://erratique.ch/software/opkg [1] https://github.com/ocaml-doc [2] http://erratique.ch/software/topkg