-
Notifications
You must be signed in to change notification settings - Fork 96
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 package documentation assets #59
Labels
Comments
Closed
This issue becomes more acute now that we have the manuals (#61). |
Merged
Closed
Ping. I've just hit this, as I was thinking about how a merlin manual (currently being written) might render on the new v3.ocaml.org |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
In b0-system/odig@90f8660 I have implemented a first shot at support for documentation assets (used by Vg since this commit dbuenzli/vg@e01ae8e) .
I do however think that
odig
is the wrong place to standardize this and that the scheme should be inodoc
(since without support in the ocamldoc language it influences the links you make in your docs) and be simply driven byodig
. As we discussed in b0-system/odig#6, unless something happens quickly at the ocamldoc level I think we should go for something straightforward, usable now.One idea would be to simply allow to do what
odig
does at the moment by adding an--assets-dir DIR
option to thehtml
command whose semantics is to simply copy over whatever is inDIR
in an_assets
directory at the root of the package HTML after having generated the HTML. However though that may be a bit build system unfriendly, anodoc asset --pkg PKG file
that copiesfile
over to_assets
would be more.Alternatively we could do nothing until there is support in the ocamldoc language/odoc and rely on
odig
's scheme meanwhile.The text was updated successfully, but these errors were encountered: