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

odoc: use upcoming support-files-targets command #1556

Closed
aantron opened this issue Nov 20, 2018 · 2 comments · Fixed by #6913
Closed

odoc: use upcoming support-files-targets command #1556

aantron opened this issue Nov 20, 2018 · 2 comments · Fixed by #6913
Assignees
Labels

Comments

@aantron
Copy link
Collaborator

aantron commented Nov 20, 2018

Currently, Dune is hardcoded to assume that the only static file generated by odoc is odoc.css. However, odoc is now also generating highlight.pack.js.

As a consequence, Dune deletes highlight.pack.js on the first rebuild of docs during directory cleanup, and does not have odoc re-generate it (which Dune wouldn't do anyway, if it expected odoc to generate the file in the first place). So, after a rebuild, highlight.pack.js is missing.

Since the set of files odoc generates is likely to change over time, odoc is adding an odoc support-files-targets command (ocaml/odoc#232). Dune should use this during docs builds. We'll probably need to add a conflict with versions of odoc that don't have support-files-targets (<= 1.3.0).

Since this requires running the odoc binary to assemble build rules, it complicates builds in which odoc itself is also being built.

The issue with highlight.pack.js was originally reported in ocaml/odoc#153.

@ghost
Copy link

ghost commented Nov 20, 2018

In the meantime, what about we simply add highlight.pack.js as a static target, and add a conflicts with versions of odoc that don't generate this file?

@aantron
Copy link
Collaborator Author

aantron commented Nov 20, 2018

Opened #1557.

aantron added a commit that referenced this issue Nov 20, 2018
See #1556.

Signed-off-by: Anton Bachin <antonbachin@yahoo.com>
@rgrinberg rgrinberg added the odoc label May 19, 2022
@rgrinberg rgrinberg linked a pull request Feb 7, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants