odoc 1.3.0: OCaml documentation generator

[aantron]

odoc is a (relatively) new OCaml documentation generator, meant to eventually replace ocamldoc:

https://github.com/ocaml/odoc#readme

It features a powerful new cross-referencer that can handle the complexity of the OCaml module language. It's also a good opportunity to improve the quality of the output.

The 1.3.0 release is odoc's first in nearly a year. It includes a pretty large refactoring, and many new features. Highlights include new CSS, BuckleScript, and Reason support.

See the changelog below!

Additions

• Reason syntax output (Add Reason support odoc#156, Patrick Stapfer).
• BuckleScript support (Support BuckleScript (Backport to 4.02.3) odoc#179, Leandro Ostera).
• New CSS, appearance (HTML/CSS improvements odoc#139, Rizo Isrof).
• Table of contents for the sections in each page (ocaml/odoc@fe26392).
• Navigation breadcrumbs, and limit length of module paths in page titles (Breadcrumbs + 2-level module path odoc#150, Yotam Barnoy).
• Syntax highlighting of code blocks (ocaml/odoc@99f2be9).
• Compiled odoc binary is now self-contained and requires no external files (ocaml/odoc@bd3b53c).
• --theme-uri option (Add theme URI option odoc#154, Rizo Isrof).
• Option to convert .mld to HTML fragments rather than complete pages (Support for HTML fragments odoc#166, Rizo Isrof).

Bugs fixed

• Use regular dashes in arrows to support ligature fonts (Use regular dash in arrows to support ligatures odoc#180, Leandro Ostera).
• Do not excessively indent code blocks (Fix indentation of code blocks odoc#133, Bobby Priambodo).
• Always prepend page- to output file name when compiling .mld files (Always use "page-" prefix when compiling mld files odoc#183, Rizo Isrof).
• Support floatarray type introduced in OCaml 4.06 (ocaml/odoc@eb36158, Thomas Refis).
• Support destructive type substitution (ocaml/odoc@57cbb4e, Thomas Refis).
• Render <i> tags in italics (Force <i> font style to italic odoc#104, Thibault Suzanne).
• Flush HTML output correctly (Always flush the HTML output. odoc#167, Rizo Isrof).
• Make HTML output more valid (Generate Valid HTML odoc#185, Leandro Ostera).
• Various improvements to parsing, output, documentation, and the development workflow (Yotam Barnoy, Luke Czyszczonik, Mohamed Elsharnouby, Rudi Grinberg, Rizo Isrof, Leandro Ostera, Bobby Priambodo, Thomas Refis, Patrick Stapfer).

Build and development

• odoc is now one repo.
• Dropped several dependencies.
• Considerable refactoring.
• New commnt parser (ocaml/odoc@78a6699).
• Improved development workflow, including CONTRIBUTING.md, tests, coverage analysis, CI, and issue organization.
• Initial NPM packaging (Leandro Ostera, Setup NPM Packaging odoc#214).
• Skeleton of odoc manual (Leandro Ostera, Begin new odoc manuals odoc#203).

[camelus]

☀️ All lint checks passed a885527

• These packages passed lint tests: odoc.1.3.0

---

☀️ Installability check (9791 → 9792)

• new installable packages (1): odoc.1.3.0

[aantron]

The revdeps failure is unrelated to odoc.

[kit-ty-kate]

Thanks!

[aantron]

Thank you!