add sphinx documentation to gh pages #400
Conversation
karosc
commented
Jan 26, 2023
karosc
commented
- new workflow for publish docs to gh-pages
- docs are built whenever there is a push or PR event regardless of branch (to keep tabs on docs stability during development)
- docs are only published when there is a push in to master or a merged PR into master. Makes deployed docs representative of current release since we should only push/merge to master right before a release.
- separate doc dependencies into separate file
- add caching to gh workflows
- new workflow for publish docs to gh-pages - separate doc dependencies into separate file - add caching to gh workflows
|
@karosc i am trying to figure out if we need to push the orphan branch gh-pages to the repo right now. Do you need me to do anything aside from approve this PR? |
|
@bemcdonnell, we do not need to publish an orphan branch now. After we push a new tag, the gh-pages branch should just auto publish. We then we need to change a repository setting to tell github to serve pages from that branch, after we do that, we shouldn't need to do anything manually again. New docs will auto deploy every time we push an new version tag. |
|
@bemcdonnell, I'm not sure if you want to work on setting up a custom domain now or at a later date: github.com/peaceiris/actions-gh-pages#%EF%B8%8F-add-cname-file-cname docs.pyswmm.org would be nice 😄 |
|
@karosc i know exactly where to go to get pyswmm docs served on gh-pages. I can do that shortly. As for the subdomain, I am using godaddy for pyswmm so I can add the subdomain once we have the link up |
