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.

Sign up for GitHub

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

Jump to bottom

Add OCaml documentation #227

Closed
3 of 4 tasks
franziskuskiefer opened this issue Oct 10, 2022 · 3 comments · Fixed by #310
Closed
3 of 4 tasks

Add OCaml documentation #227

franziskuskiefer opened this issue Oct 10, 2022 · 3 comments · Fixed by #310
Assignees
@franziskuskiefer
Labels
documentation 🗒 Improvements or additions to documentation
Milestone
Documentation

Comments

@franziskuskiefer
Copy link
Member

franziskuskiefer commented Oct 10, 2022 •
edited
Loading

@franziskuskiefer franziskuskiefer mentioned this issue Oct 10, 2022
Closed
27 tasks
@franziskuskiefer franziskuskiefer added the documentation 🗒 Improvements or additions to documentation label Oct 10, 2022
@franziskuskiefer franziskuskiefer added this to the Documentation milestone Oct 17, 2022
@franziskuskiefer
Copy link
Member Author

Building OCaml docs

./opam.sh
cd opam
dune build @doc

The resulting docs in _build/default/_doc/_html/ should be displayed at ocaml/main/index.html.

Open questions

  • how to do versioning (proposal: publish to ocaml/version/ and just link from the book)

@franziskuskiefer franziskuskiefer self-assigned this Oct 17, 2022
@franziskuskiefer franziskuskiefer mentioned this issue Oct 17, 2022
Merged
@victor-dumitrescu
Copy link
Collaborator

Regarding versioning, this is not a feature that odoc supports, so we'll probably need to do something manual, like checking in the generated docs for every version.

@franziskuskiefer
Copy link
Member Author

odoc doesn't seem to provide a way to silence warnings selectively

Originally posted by @victor-dumitrescu in #236 (comment)

@franziskuskiefer franziskuskiefer removed their assignment Nov 2, 2022
@franziskuskiefer franziskuskiefer mentioned this issue Dec 14, 2022
Merged
@franziskuskiefer franziskuskiefer self-assigned this Dec 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@franziskuskiefer franziskuskiefer

Labels
documentation 🗒 Improvements or additions to documentation
Projects
HACL Packages
Status: Done
Milestone
Documentation
Development

Successfully merging a pull request may close this issue.

job to build docs for ocaml tags cryspen/hacl-packages
2 participants
@franziskuskiefer @victor-dumitrescu