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

readthedocs action on master #87

Open
hareball90 opened this issue Jul 20, 2023 · 5 comments
Open

readthedocs action on master #87

hareball90 opened this issue Jul 20, 2023 · 5 comments
Labels
Milestone

Comments

@hareball90
Copy link
Collaborator

when pushing to master branch, update the documentation so that a push/release on master triggers an update to readthedocs which updates pygom version release info and the link to the jupyterbook hosted on ghpages

@hareball90
Copy link
Collaborator Author

something like this https://readthedocs.org/projects/jupyter-book/

@hareball90
Copy link
Collaborator Author

use this example from jupyterbook tutorial deployment
https://github.com/executablebooks/jupyter-book/blob/master/.readthedocs.yml

@hareball90
Copy link
Collaborator Author

@twomagpi will need to give access to Joe / Steven for updating this

@hareball90
Copy link
Collaborator Author

Context
Originally the doc build was too large for RTD to compile. Fix: build a subset of docs on RTD and full docs locally.
Now, build the full documentation with github actions/pages, which will lnot be restricted to the same timeout constraint. Then if possible, upload htmls from the github build to readthedocs.

@twomagpi
Copy link
Collaborator

twomagpi commented Aug 7, 2024

Need to either update / remove / massively simplfy the RTD pages following #114

@twomagpi twomagpi added this to the v0.1.9 milestone Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants