Dev meeting 2021 03 11

Jump to bottom

Jon Ludlam edited this page Mar 25, 2021 · 1 revision

Odoc dev meeting 2021-03-11

Attendees

@jonludlam @lpw25 @lubega-simon @lortex @julow

2.0 issues

JS run

JS used beta2 and reported no OOM issues, but some layout problems with includes (possibly fixed since?)

Issues

https://github.com/ocaml/odoc/issues?q=is%3Aopen+is%3Aissue+milestone%3A2.0.0

Discussion needed:

#541 (Alignment "styles" (Center, Left, Right) are not supported) - @lubegasimon working on it

Fixed since last time:

#560 (Dead links to hidden items appearing in documentation) - @lubegasimon (https://github.com/ocaml/odoc/pull/583)
@jonludlam to double check
#587 (include Subst failure) - @jonludlam (https://github.com/ocaml/odoc/pull/603)
#558 (Support canonical on module types, types, etc.) @jonludlam (https://github.com/ocaml/odoc/pull/596)
#586 (CSS regression) @dbuenzli
#297 (!modules should splice in docs) - @julow working on it (https://github.com/ocaml/odoc/pull/597) Heading texts in synopsis: https://github.com/ocaml/odoc/pull/628

PRs open:

#590 (Enable references to refer to pages with '.' or '-')

In progress:

#328 (Module preamble/header detection) - in progress, @Julow working on it
#478 (Top-level doc-comments of module types are discarded) - @Julow working on it, good progress Plumbing done, TODO: generator part
#460 (reference driver needed) - addressed above
#573 (docs are bad) - addressed above
#557 (Command to extract errors from odocl files) - @jonludlam to fix

Unstarted:

#559 (Canonical does not work on compilation units) - Unassigned
#601 (Type extensions are no anchorable and should be classified as type) Proposition suggested on the ticket.

-- do we need this one? no!

Headings in preamble Related issue: https://github.com/ocaml/odoc/issues/631 We take the first comment of the module expansion up until the first top level header to be preamble (fused with the attached comment of the module)

odoc-parser

to be removed from odoc.opam - keep code in odoc.git, make it octavius v?.?.?

docs.ocaml.org

-- @lortex working on docs.mirage.io - using voodoo, building ocurrent pipeline for it.