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

Add Actions script to build and deploy to gh-pages #3224

Merged
merged 4 commits into from
Dec 18, 2020

Conversation

rajat2004
Copy link
Contributor

Fixes:

  • Adds GitHub Action to build docs including API reference docs, and deploy to gh-pages on push to master branch (requires maintainer to add GITHUB_TOKEN key!)
  • Small cleanup of build_api_docs.sh script, uitls.py and fixes simCreateVoxelGrid docstring

About

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 date

How 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):

@jonyMarino
Copy link
Collaborator

Thanks, @rajat2004! Another great facility for us and improvement for the community!
I think you can test this if you merge this to your fork/master. Am I correct?

@rajat2004
Copy link
Contributor Author

@jonyMarino Not sure, I did read somewhere that forks have read access only as expected, so I'll probably have to enable pages on my fork and test it, will try to do it in a few days

@jonyMarino
Copy link
Collaborator

@rajat2004 Do not bother. It is not a dangerous change; I am going to merge and test it.

@jonyMarino jonyMarino merged commit d9114f2 into microsoft:master Dec 18, 2020
@jonyMarino
Copy link
Collaborator

The checks are passing. But I'm not sure how to proceed with the token. Is it not have to be present in the .yml like here: https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#example-passing-github_token-as-an-input?

@rajat2004 rajat2004 deleted the docs-gh-action branch December 18, 2020 17:06
@rajat2004
Copy link
Contributor Author

@jonyMarino Yup, you're correct, really sorry for missing that! I've opened #3231 which fixes this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants