caml-list - the Caml user's mailing list
 help / Atom feed
* [Caml-list] [ANN] Odig 0.0.4
@ 2019-03-08 18:27 Daniel Bünzli
  0 siblings, 0 replies; 1+ messages in thread
From: Daniel Bünzli @ 2019-03-08 18:27 UTC (permalink / raw)
  To: caml-list

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



^ permalink raw reply	[flat|nested] 1+ messages in thread

only message in thread, back to index

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-03-08 18:27 [Caml-list] [ANN] Odig 0.0.4 Daniel Bünzli

caml-list - the Caml user's mailing list

Archives are clonable: git clone --mirror https://inbox.ocaml.org/caml-list

AGPL code for this site: git clone https://public-inbox.org/ public-inbox