Skip to content

Dev meeting 2020 10 01

Jon Ludlam edited this page Oct 2, 2020 · 3 revisions

Agenda

Attending

  • @jonludlam
  • @Julow

Previous actions

  • @jonludlam to find out status of dune build @doc supporting external libs -- Not done

  • @jonludlam to post on discuss about plans for replacing ocamldoc plugins -- Not done

  • @jonludlam to ask @dbuenzli whether odig uses odoc html-fragment

    • asked, awaiting answer
    • odig has code to call html-fragment
    • not used when I last ran odig over my installed packages.

CI

CI now largely working again, with the exception of the docs test (!) in ocaml-ci. The problem there is that the test is checking that dune build @doc succeeds, but dune can only drive odoc to build the docs within the dune project, and odoc therefore currently complains that it can't resolve and expand paths to system-installed libraries. @Julow is working on a fix for this.

Comment parser

One of the issues with the CI was that there exists a circular dependency between mdx, which requires odoc for its comment parser, and odoc, which requires mdx for its test suite.

Warnings, Errors and Results

Parent/Child doc

Updated doc here: https://github.com/ocaml/odoc/wiki/Document-Tree-model