2.2.0

CHANGES:

Additions

• New unstable option --as-json for the HTML renderer that emits HTML
  fragments (preamble, content) together with metadata (table of contents,
  breadcrumbs, whether katex is used) in JSON format. (@sabine, #908)
• New maths support via {m ... } and {math ... } tags. (@giltho, @gpetiot, #886)
• Various optimisations (@jonludlam, #870, #883)
• Better handling of alerts and deprecation notices. (@panglesd, #828)
• Handle language tags on code blocks (@Julow, #848)

Bugfixes

• Shadowing issues (@jonludlam, #853)
• Layout fixes and improvements (@panglesd, #832, #839, #847)
• Handle comments on class constraints and inherit (@Julow, #844)
• Disable the missing root warning (@jonludlam, #881)

2.1.1

CHANGES:

• OCaml 5.0 compatibility (@dra27, #873)

2.2.0 alpha

This pre-release is intended to be used to test some bugfixes.

2.1.0

CHANGES:

Additions

• New subcommand to resolve references (@panglesd, @lubega-simon, #812)
• Improved rendering of long signatures (@panglesd, #782)
• Handle comments attached to open statement as floating comment, instead
  of dropping them (@panglesd, #797)
• Empty includes (containing entirely shadowed entries) are now hidden (@panglesd, #798)

Bugs fixed

• Fix a missing Result constructor during compile. This will cause some
  functor arguments to have different filenames (@jonludlam, #795)
• Better memory/disk space usage when handling module alias chains (@jonludlam, #799)
• Resolving class-type paths (ie., val x : #c) (@jonludlam, #809)
• Skip top-level attributes while extracting the top comment. Fix top-comment extraction with PPX preprocessing (@jorisgio, #819)
• Better handling of @canonical tags (@jonludlam, #820)
• css: improved layout (@jonludlam, @Julow, #822)

2.1.0 alpha release

Alpha release to test the memory usage of odoc.

2.0.2

CHANGES:

Additions

• Compatibility with OCaml 4.14 (@patricoferris, @kit-ty-kate, #788)

2.0.1

CHANGES:

Bugs fixed

• Man page renderer fails to output pages that have children (@jonludlam, @Julow, #766)
• Fix resolution of unprefixed references to pages (@Julow, #755)
• Fix reporting of ambiguous labels (@Julow, @jonludlam, #773, #781)
• Allow referencing of labels in the top comment (@jonludlam, #771)

Additions

• Strip unquoted spaces in identifiers for a more flexible reference syntax (@lubega-simon, @panglesd, #783)
• Add context to messages raised in expansions of includes (@Julow, #780)

2.0.0

CHANGES:

Breaking changes

• Remove odoc-parser into a separate repository (@jonludlam, #700)

Additions

• OCaml 4.13 support (@Octachron, #687, #689)
• Better errors/warnings (@Julow, #692, #717, #720, #732)
• ModuleType 'Alias' support (@jonludlam, #703)
• Improved test suite (@lubega-simon, #697)
• Improved documentation (@lubega-simon, @jonludlam, #702, #733)
• Strengthen module types (@jonludlam, #731)

Bugs fixed

• uwt now can be documented (@jonludlam, #708)
• Fix resolution involving deeply nested substitutions (@jonludlam, #727)
• Fix off-by-one error in error reporting (@asavahista, #736)

1.5.3

CHANGES:

Additions

• Compatibility with OCaml 4.13 (#699, @Octachron)

2.0.0-beta4

CHANGES:

Additions

• Handle @canonical tags in the top-comment of modules (@Julow, #662)
• Simplify paths referring to Stdlib (@jonludlam, #677)
• New odoc command to report warnings encountered during compilation/linking (@Julow, #667)
• Anchors on type extensions (@Julow, #684)

Bugs fixes

• Resolve references in module synopses (@Julow, #658)
• Fix reference resolution in the presence of shadowing (@Julow, #682)