Adding GH pages functionality #365
Conversation
DetailsRight now the workflow doesn't work perfectly. I have tried to incorporate multiple versions of the docs, but certain limitations of GH actions makes it difficult to build multi-versions through an action rather than building it by hand and pushing it to main or some documentation branch. @kaklise We should discuss which versions/tags we actually want to be available on the documentation before I troubleshoot anymore. If we want multiple branches to be built and deployed we may have to create a separate documentation branch, but if its just tags I think we can keep things how they are (no dedicated docs branch). Whatever we settle on, once we pull this in we will need to activate GH pages in the repo settings. |
|
|
||
| on: | ||
| push: | ||
| branches: [main, pages] |
There was a problem hiding this comment.
Do we need a pages branch?
There was a problem hiding this comment.
Ah, no we don't. That's a relic from getting things to work on my fork without pushing into main. I'll remove
Summary
Added an action that builds the documentation and deploys it to the github pages url for the repo. This also required updating the requirements and configuration for the documentation, as well as adding a couple of html files for multi-version functionality.
Tests and documentation
None needed
Acknowledgement
By contributing to this software project, I acknowledge that I have reviewed the software quality assurance guidelines and that my contributions are submitted under the Revised BSD License.