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 package documentation assets #59

Open
dbuenzli opened this issue Jan 11, 2017 · 3 comments
Open

Support for package documentation assets #59

dbuenzli opened this issue Jan 11, 2017 · 3 comments
Labels

Comments

@dbuenzli
Copy link
Contributor

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 in odoc (since without support in the ocamldoc language it influences the links you make in your docs) and be simply driven by odig. 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 the html command whose semantics is to simply copy over whatever is in DIR 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, an odoc asset --pkg PKG file that copies file 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.

@dbuenzli
Copy link
Contributor Author

dbuenzli commented Oct 25, 2017

This issue becomes more acute now that we have the manuals (#61).

@trefis
Copy link
Contributor

trefis commented Jan 18, 2022

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
It seems pretty important to have this.

@trefis
Copy link
Contributor

trefis commented Jan 18, 2022

(And indeed https://v3.ocaml.org/p/vg/0.9.4/doc/Vg/index.html#paths vs https://erratique.ch/software/vg/doc/Vg/index.html#paths )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants