Skip to content

per-package odoc docs via odoc_driver_voodoo - #5

Open
jonludlam wants to merge 2 commits into
avsm:mainfrom
jonludlam:docs-rfc
Open

jonludlam wants to merge 2 commits into
avsm:mainfrom
jonludlam:docs-rfc

Conversation

@jonludlam

Copy link
Copy Markdown

When a project's solve includes the oi-docs conf-package, every package's build runs odoc_driver_voodoo --blessed after Apply_install_file and captures the resulting odoc/{html,odoc}/p///... tree into the same layer's fs/.

Currently only per-package docs are created, no overall index.

The end result is visible at _oi/prefix/odoc/html/

@jonludlam

Copy link
Copy Markdown
Author

Before this can be merged, I need to have an overlay in reporepo with oi-docs!

Jon Ludlam's Agent added 2 commits May 20, 2026 14:57
When a project's solve includes the oi-docs conf-package, every package's
build runs `odoc_driver_voodoo --blessed` after Apply_install_file and
captures the resulting odoc/{html,odoc}/p/<pkg>/<ver>/... tree into the
same layer's fs/.

Currently only per-package docs are created, no overall index.

The end result is visible at _oi/prefix/odoc/html/
This package serves as a boolean 'build-docs' switch. If it's in the
dependencies, build the docs. If not, don't. This means that this branch
can now be merged and it won't break anything due to an unknown package.
@jonludlam

Copy link
Copy Markdown
Author

Rather than requiring an overlay with the 'oi-docs' package, this now embeds the package. This means docs should be available without requiring any overlay.

There is still a need to add odoc-driver, sherlodoc and odoc-md to the toolchain package though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant