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

Too much clicking required to see documentation #112

Open
johnwhitington opened this issue Oct 6, 2021 · 1 comment
Open

Too much clicking required to see documentation #112

johnwhitington opened this issue Oct 6, 2021 · 1 comment

Comments

@johnwhitington
Copy link

Just started using Yojson, for which many thanks. I am round-tripping PDFs through JSON.

https://ocaml-community.github.io/yojson/

is mostly empty and points to

https://ocaml-community.github.io/yojson/yojson/index.html

which is mostly empty and points to (for most users)

https://ocaml-community.github.io/yojson/yojson/Yojson/index.html

Is there a way to squish some of this together? Meanwhile I have used a bookmark, of course.

@Leonidas-from-XIV
Copy link
Member

I understand your concern and it while I agree that it would be nice to at least not have the first page if there is only one package. At the moment there are two for technical reasons.

This is generated by odoc and I am not sure there's much that can be configured. Maybe this would be good to submit as a feature request to odoc?

Meanwhile, the docs can now also be browsed on V3 of ocaml.org, which has the advantage that it generates the API for the respective versions automatically instead of just pushing the latest release on github pages as we do at the moment.

I think the way forward for us would be to use some Github action to regenerate the gh-pages on every push to master (thus basically serving as the "development version docs", while the released docs would live on ocaml.org.

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