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

Doc site should be built by CI and installed on github pages #33

Open
robtaylor opened this issue Sep 2, 2023 · 1 comment
Open

Doc site should be built by CI and installed on github pages #33

robtaylor opened this issue Sep 2, 2023 · 1 comment
Assignees
@robtaylor @jpc-lip6
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@robtaylor
Copy link
Collaborator

We should have a CI step for building the docs and installing on our github page. We should also remove the committed generated files related to documentation.
@robtaylor robtaylor added the good first issue Good for newcomers label Sep 2, 2023
@robtaylor robtaylor added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Sep 2, 2023
@robtaylor robtaylor mentioned this issue Nov 17, 2023
Merged
@Coloquinte
Copy link
Collaborator

At the moment, there is an action that is supposed to build the doc and push them to Github pages.

The deployment to the gh-pages branch works. However, links generated for a PR preview don't work, and it's unclear if the pages at lip6.github.io/coriolis/ are updated when deploying

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@robtaylor robtaylor

@jpc-lip6 jpc-lip6

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@robtaylor @Coloquinte @jpc-lip6