odoc icon indicating copy to clipboard operation
odoc copied to clipboard

Show packages and libraries in the breadcrumbs

Open Julow opened this issue 1 year ago • 3 comments

This is still work in progress as pages that are inside a library are not recognized and the library name might be inconsistent with the one passed to the link command.

This makes the breadcrumbs more readable by removing uninterested components and make the beginning of the module path more recognizable. The `Library constructor is added to identifiers to propagate this information.

Julow avatar Aug 26 '24 12:08 Julow

This change requires a change in sherlodoc, likely due to the change in the identifier type.

Do you have a branch with the required modification, so that I can test this PR?

panglesd avatar Aug 28 '24 08:08 panglesd

Oops I forgot about that. Here's the fix: https://github.com/jonludlam/sherlodoc/pull/1 (branch odoc3_breadcrumbs_library)

Julow avatar Sep 05 '24 09:09 Julow

I'll put this PR as a draft while I work a bit more on breadcrumbs to be sure it's the right direction. We'll have to propagate the "short title" of pages into the breadcrumbs, also for package and library index pages, and I don't know if this change will still be required for that.

Julow avatar Sep 06 '24 09:09 Julow

Closing as this is probably not the right approach. Maybe https://github.com/ocaml/odoc/pull/1196 is better.

Julow avatar Sep 27 '24 09:09 Julow