[ANN] Odoc 3.0 released!

Ecosystem
1

On behalf of the Odoc development team, I’m delighted to announce the release of Odoc 3! This is a big big release with loads of new features and bug fixes, and I encourage everyone to install it and have a play!

For an overview of the new features see our beta release announcement. tl;dr:

$ opam install odoc-driver # will install odoc 3
$ odoc_driver odoc odoc-parser odoc-driver odoc-md sherlodoc --remap

and point your browser at _html/index.html. This example shows odoc_driver creating the docs for the 5 packages specified and remapping links to other packages (see here for an explanation)

If you try the above command, you’ll note something interesting, and hopefully this will encourage you to run odoc_driver on your own packages before you release them, as then you’ll be able to avoid slightly embarrassing post-release fixes like this one :grimacing:

Here are the changes from the beta release:

Added

Changed

Fixed

30 Likes
2

The link appears to be broken

1 Like
3

Fixed the link, thanks!

4

Changing the major version of a package is a big step. What warranted the change? Is there one new feature of odoc that made you really “oh this is huge, we need to change the major version”?

1 Like
5

…or perhaps a breaking change (https://semver.org/)?