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

Publish documentation on github.io #140

Open
Tracked by #105
ezio-melotti opened this issue Sep 11, 2021 · 2 comments
Open
Tracked by #105

Publish documentation on github.io #140

ezio-melotti opened this issue Sep 11, 2021 · 2 comments
Labels
feature A new feature infrastructure Docker, GCP, GitHub actions, etc.

Comments

@ezio-melotti
Copy link
Collaborator

By reading https://www.docslikecode.com/articles/github-pages-python-sphinx/ and https://docs.github.com/en/pages/getting-started-with-github-pages/changing-the-visibility-of-your-github-pages-site it seems it should be possible to build the docs and publish them on a private github.io page. We could set up a GitHub action that is auto-triggered when something is pushed to docs/, that builds the docs and publishes them.

There is also a docker container that can be pulled to build the docs, and perhaps some GitHub action that does that out of the box already. I've also considered building the PDF, but it needs over 1GB of latex dependencies to be built, so it might not be worth it to automate it.

@ezio-melotti ezio-melotti added infrastructure Docker, GCP, GitHub actions, etc. feature A new feature labels Sep 11, 2021
@ezio-melotti ezio-melotti mentioned this issue Sep 17, 2021
31 tasks
@ezio-melotti
Copy link
Collaborator Author

The docs are now published at https://simoc.space/docs/user_guide/
We should automate this with a GitHub action.

@ezio-melotti
Copy link
Collaborator Author

ezio-melotti commented Mar 29, 2023

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature A new feature infrastructure Docker, GCP, GitHub actions, etc.
Projects
None yet
Development

No branches or pull requests

1 participant