-
Notifications
You must be signed in to change notification settings - Fork 703
Build and host docs via github action #167
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
5aa514e
Test GH actions to build docs
c24t c8d4d97
Use JamesIves/github-pages-deploy-action
c24t 8abcfa6
Use personal access token
c24t 640e36f
Stop jekyll
c24t 39adaf2
Build only on push to master, not on PRs
c24t 2f3e42f
Use sphinx.ext.githubpages
c24t 4378744
Install --upgrade tox on docs generation
c24t File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
name: Docs | ||
|
||
on: | ||
push: | ||
branches: | ||
- master | ||
|
||
jobs: | ||
docs: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v1 | ||
- uses: actions/setup-python@v1 | ||
- name: Build docs | ||
run: | | ||
pip install --upgrade tox | ||
tox -e docs | ||
- name: Publish to gh-pages | ||
uses: JamesIves/github-pages-deploy-action@2.0.2 | ||
env: | ||
ACCESS_TOKEN: ${{ secrets.DocsPushToken }} | ||
BRANCH: gh-pages | ||
FOLDER: docs/_build/html/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
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.
Is there also a trigger for "on successful build/checks"? That would probably be better than on every push.
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.
This should only trigger on pushes to the master branch, so after a PR has been merged. At that point the checks should have already passed. Another option is to rebuild the docs on releases, but at least for now I think it's helpful to have the docs track master.
See also the workflow syntax docs and event descriptions.