2.0.0-beta3

CHANGES:

Breaking changes

• Refactor the comment parser in preparation for it to be octavius 2 (@jonludlam, #621)

Additions

• Better HTML rendering (@dbuenzli, #607, #612, #615)
• Better handling of signature comments (@Julow, #627, #629, #640, #643, #647, #654)
• Centre, left and right alignment constructs now parse correctly (@lubegasimon, #624)
• Allow reference to pages that contain hyphens and dots (@lubegasimon, #622)
• Allow type definitions to be copied and pasted with correct syntax (@Drup, #626)
• Install Ocamlary as a library for testing (@dbuenzli, #639)
• Handle @canonical tags on compilation units (@Julow, #649)
• Alias more when strengthening (@jonludlam, #653)
• Light theme fixes (@xvw, #660)

Bugs fixed

• LaTeX: Hardened description environments (@Octachron, #608)

2.0.0-beta2

CHANGES:

Additions

• Add the ability to specifiy canonical paths for types and module types (@jonludlam, #596)
• Several improvements to the HTML tree (@dbuenzli, #600, #605, #589, @Drup, #579)
• Render module synopses in {!modules:...} (@Julow, #597)

Bugs fixed

• Fix for resolving references in mld files (@jonludlam, #611)
• Fix placement of documentation in module aliases (@Julow, #606)
• Fix breakage involving includes and shadowing (@jonludlam, #603)
• Don't link to hidden items (@lubegasimon, #583)
• Don't remove docs of inlined includes (@Julow, #595)
• Don't render shadowed values (@lubegasimon, #580)
• Fix unresolved references in the first comment of a file (@Julow, #592)

2.0.0-beta

CHANGES:

• New model for expanding and cross referencing (@jonludlam, @Julow, @lubegasimon)

This is a brand-new implementation, ensuring that the expansions and links are
correct, requring no rendering of hidden modules, and correctly handling functors,
destructive substitution, module type of expressions, dependently-typed functors
and other complex language features.

• New document output layer, supporting HTML, LaTeX and man page output (@Drup, @Octachron, @jonludlam, @Julow, @lubegasimon)

This release introduces a new intermediate representation of the documentation,
allowing new backend renderers to be added without having to understand every
detail of the language. Included with this release are renderers for HTML,
LaTeX and man pages.

• Experimental parent/child support for structured output (@jonludlam)

This allows the output pages to be structured in a hierarchy. This is an experimental
feature intended to enable the support of more complex outputs, such as that required
to produce a site documenting all opam packages.

1.5.2

CHANGES:

Additions

• Compatibility with OCaml 4.12 (#531, @Octachron)

pre-alpha-8

Update README.md

pre-alpha-7

Remove unecessary line ending computation

1.5.1

CHANGES:

Additions

• Compatibility with OCaml 4.11 (#434, @kit-ty-kate)

odoc 1.5.0

CHANGES:

Additions

• Add option to turn warnings into errors (#398, Jules Aguillon)

Bugs fixed

• Emit quote before identifier in alias type expr (#391, Anton Bachin)
• Handle generalized open statements introduced in 4.08 (#393, Jon Ludlam)
• Refactor error reporting to avoid exiting the program in library code
  (#400, Jules Aguillon)
• Build on OCaml 4.10 (#408, Jon Ludlam)

odoc 1.4.2

Bugs fixed

• Build on OCaml 4.09 (#383, Anil Madhavapeddy).
• Handle OCaml 4.08 type and module substitutions (#381, Jon Ludlam).
• Parser: better trimming of leading whitespace in code blocks (#370, Jules Aguillon).
• Parser: allow references to operators containing : characters (#384, reported Sylvain Le Gall).
• HTML: emit <meta generator> again (#378, Daniel Bünzli).
• CLI: odoc html-targets was ignoring deeply nested modules (#379, Daniel Bünzli).
• Fix bad internal usage of List.iter2 (#376, Yotam Barnoy).

odoc 1.4.1

Bugs fixed

• Messy formatting in large definitions due to lack of <span>s (#360, Thomas Refis).
• Missing table of contents on .mld pages (#361, Rizo Isrof).
• Missing space before polymorphic class names (#339, Kevin Ji).
• Module type definitions printed with : instead of = (#344, Geoff Reedy).
• Conjunctive types printed with * instead of & (#353, Florian Angeletti).
• Type extensions (+=) printed without CSS classes found in other items (#348, reported Stéphane Lavergne).
• High memory usage on large codebases (#361, Thomas Refis).
• Build: double underscores in internal filenames (#357, Thomas Refis).
• Development: test suite assumed that html5-tidy supports --mute (#345, Geoff Reedy).
• Internal: refactored AST (#351, #364, Jules Aguillon).