Add Actions script to build and deploy to gh-pages #3224
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.
Fixes:
gh-pages
on push to master branch (requires maintainer to add GITHUB_TOKEN key!)build_api_docs.sh
script,uitls.py
and fixessimCreateVoxelGrid
docstringAbout
Currently, pushing the updated files to
gh-pages
is done manually by the maintainers, which frequently results in the .md files and documentation website being out of sync for months. Automating the deployment will update the github pages website everytime a push is made to master branch, also keeping the API reference docs up to dateHow Has This Been Tested?
Docs build can be checked locally, however the deployment hasn't been tested, and needs to be done by maintainers to add the secret token.
Screenshots (if appropriate):