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

CI for documentation #7

Open
khieta opened this issue Dec 17, 2021 · 3 comments
Open

CI for documentation #7

khieta opened this issue Dec 17, 2021 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@khieta
Copy link
Member

khieta commented Dec 17, 2021 •
edited
Loading

Add CI support for auto-generating documentation.

For reference, how we currently generate documentation is:

  1. merge the main branch into the gh-pages branch
  2. Run make doc in the gh-pages branch
  3. Push the new docs folder
@khieta khieta added the documentation Improvements or additions to documentation label Dec 22, 2021
@khieta khieta closed this as completed Jun 22, 2022
@khieta khieta reopened this Jun 22, 2022
@khieta
Copy link
Member Author

khieta commented Jun 22, 2022

(Reopened & revised description)

@khieta khieta changed the title Documentation CI for documentation Jun 22, 2022
@k4rtik
Copy link
Member

k4rtik commented Jul 15, 2022

I may be able to help with this.

@k4rtik
Copy link
Member

k4rtik commented Jul 31, 2022

It seems dune now (as of v3.3) supports creating documentation using the dune build @doc command. See https://github.com/ocaml/dune/releases/tag/3.3.0

I am working on #26, but will let this potential switchover to dune be a later improvement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@k4rtik @khieta