odoc icon indicating copy to clipboard operation
odoc copied to clipboard

Driver: generate "external" pages

Open panglesd opened this issue 1 year ago • 1 comments

This adds generation of (basic) pages for:

  • A "list of all packages" page (at the root of the doc)
  • A landing page for each package (in the <pkgname>/ folder)
  • A landing page for the list of libraries (in the <pkgname>/lib/ folder)
  • A landing page for each library (in the <pkgname>/lib/<libname> folder)

This PR does not touch only the driver: I had to add the possibility of an empty --parent-id for the "list of all packages" page.

I also had to avoid "relative references" in the generated pages as they are did not resolve. I used `rooted absolute references instead, and I will investigate the bug.

This will hopefully be useful to test various ideas for the breadcrumbs.

panglesd avatar Jul 31 '24 15:07 panglesd

(Hopefully, this can be made less clicky by having the landing page of a package be better (similar to odig's one / ocaml.org's one), but it's nice that library list and library landing page exists to avoid 404 pages eg on handcrafted path)

panglesd avatar Jul 31 '24 15:07 panglesd

I think it'd be useful to have some tests for the changed functionality in odoc itself.

jonludlam avatar Aug 21 '24 10:08 jonludlam

Rebased!

panglesd avatar Aug 23 '24 11:08 panglesd