-
Notifications
You must be signed in to change notification settings - Fork 213
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
Migrate documentation deployment from Travis CI to GitHub Actions #713
Conversation
release: | ||
types: | ||
- published |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also trigger builds for tags/releases.
Ping @GenericMappingTools/python for review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for the delay in review. A quick scan and this seems fine to me, though I would prefer if @leouieda (who has more experience on Github Actions docs deploy) take another look. Otherwise, I think you can make the necessary pre-merge changes mentioned at https://github.com/GenericMappingTools/pygmt/pull/713/files#r535384202 and other places.
Description of proposed changes
This is the last step of the CI migration from Travis to GitHub Actions.
The codes are copied from https://github.com/fatiando/boule/blob/master/.github/workflows/docs.yml.
For testing purpose, the deployment steps are enabled for PRs temporarily, and the documentation is deployed to the
gh-pages-testing
branch.It seems working very well (see https://github.com/GenericMappingTools/pygmt/tree/gh-pages-testing).
Fixes #566.
TODO
.travis.yml
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Notes
/format
in the first line of a comment to lint the code automatically