Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for dune's (private_modules ...) #1327

Open
davesnx opened this issue Mar 6, 2025 · 4 comments
Open

Support for dune's (private_modules ...) #1327

davesnx opened this issue Mar 6, 2025 · 4 comments

Comments

@davesnx
Copy link

davesnx commented Mar 6, 2025

private_modules shouldn't be linked in the documentation, similar to #560

Given a library like

(library
 (name JSX)
 (private_modules Html)
 (public_name html_of_jsx))

should not a broken reference like this one: "https://davesnx.github.io/html_of_jsx/html_of_jsx/JSX/Html/index.html"

Image

@jonludlam
Copy link
Member

I'm having a bit of trouble reproducing the problem. Are you using odoc_driver to create the docs or dune or something else? If odoc_driver, is it producing docs from what's installed into opam or are you running it with dune exec -- odoc_driver?

@davesnx
Copy link
Author

davesnx commented Mar 10, 2025

No, running odoc from dune so not the driver. Not sure how useful is, but checking out this davesnx/html_of_jsx@d37ca0c, building, etc should give you a repro

@jonludlam
Copy link
Member

When I clone that repo at that hash and do dune build @doc I get the don't get any broken reference - I get

module Html : module type of Html

which is admittedly a bit weird, but both links take me to a rendered module. What am I missing?

@davesnx
Copy link
Author

davesnx commented Mar 10, 2025

Made a small video to showcase it: https://supercut.video/share/davids/7qL_KVHA4B7OZbRjiwbhyo

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

No branches or pull requests

2 participants