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

Internal documentation links are missing a base url #13

Open
art-w opened this issue Feb 1, 2024 · 2 comments
Open

Internal documentation links are missing a base url #13

art-w opened this issue Feb 1, 2024 · 2 comments

Comments

@art-w
Copy link
Owner

art-w commented Feb 1, 2024

Links in documentation comments works correctly in the odoc static html results. On the opam-wide website however, they don't point to a valid url as the links are relative (and so don't point to ocaml.org).

For example Stdlib.List.flatten has the description Same as {!concat} but the link to concat is broken (... the links are rendered in black with css to avoid the user clicking them!). We would probably need some support from odoc html rendering to specify a base url... or we could hack the odoc generated html to fix the links.

@EmileTrotignon
Copy link
Collaborator

I have tried to add a test for this : #22
However the links are not include in the docstring when it is rendered by odoc for the search. How do you get them on www sherlodoc ?

@art-w
Copy link
Owner Author

art-w commented Feb 6, 2024

Thanks for the test! Indeed hm, perhaps the links on doc.sherlocode.com are coming from my dirty rebase of odoc.search for odoc 2.2.0 to run on the voodoo generated files... I'll try again without my hacks once ocaml-doc/voodoo#128 is live and close this issue :)

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