From: "Daniel Bünzli" <daniel.buenzli@erratique.ch>
To: caml-list@inria.fr
Subject: [Caml-list] [ANN] Odig 0.0.4
Date: Fri, 8 Mar 2019 19:27:20 +0100 [thread overview]
Message-ID: <etPan.5c82b408.7f4b1698.3954@erratique.ch> (raw)
Hello,
It's my pleasure to announce a new release of odig.
odig is a command line tool to lookup documentation of installed
OCaml packages. It shows package metadata, readmes, change logs,
licenses, cross-referenced odoc API documentation and manuals.
To browse the documentation of your opam switch's packages simply
proceed with:
opam install ocaml-manual odig
odig doc
An odig manual and the packaging conventions can be consulted via:
odig doc odig # or see https://b0-system.github.io/odig/doc/odig
A sample output on a best-effort maximal set of packages of the
opam repository can be found here:
https://b0-system.github.io/odig/doc/
The highlights of this release are:
* Support for the latest odoc (includes navigation improvements).
* Support for mld manuals and package landing page customization.
See for example: https://b0-system.github.io/odig/doc/odig
* Support for API documentation themes. The default odoc theme
and light and dark themes optimized for legibility are bundled
with odig; and you can bring your own via opam packages. The
odig default themes can be spotted online by following the
links here:
https://github.com/b0-system/odig#sample-odoc-api-documentation-and-manuals
* Support for OCaml manual theming when the `ocaml-manual`
package is installed. Provides a best-effort (for better
results a closer rework of the manual HTML gen would be needed)
seamless style transition between API docs and the OCaml
manual. For example follow the link to the manual on:
https://b0-system.github.io/odig/doc/
The release notes have all the details, especially removals details from 0.0.3:
https://github.com/b0-system/odig/blob/v0.0.4/CHANGES.md
Most of this is brought to you thanks to support added in `odoc`
by Thomas Refis and Rizo Isrof. Thanks also to Thomas Refis for
helping with `odoc` driving details, with `odoc` bug chasing and
discussions.
Homepage: http://erratique.ch/software/odig
Best & happy documentation reading,
Daniel
reply other threads:[~2019-03-08 18:27 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=etPan.5c82b408.7f4b1698.3954@erratique.ch \
--to=daniel.buenzli@erratique.ch \
--cc=caml-list@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).