added GH action for generating docs on release #120
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a github action for generating documentation on release using Sphinx and force-pushing it to the
documentation
branch. It will require a minor change in repository settings (from deploying github pages from thedocs
directory toroot
directory in thedocumentation
branch). It also allows this action to be run on-demand when a documentation update is necessary.Checklist
For reviewers
later.
__init__.py
.