-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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,42 @@ | ||
name: deploy-documentation | ||
|
||
# Only run this when the master branch | ||
on: | ||
push: | ||
branches: | ||
- master | ||
- develop | ||
- feature/sphinx | ||
# Option to run action manually | ||
workflow_dispatch: | ||
inputs: | ||
tag: | ||
description: Tag for manually deploying docs website | ||
required: False | ||
default: "" | ||
permissions: | ||
contents: write | ||
|
||
# This job installs dependencies, builds the documentaiton, and pushes it to `gh-pages` | ||
jobs: | ||
deploy-docs: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Set up Python 3.8 | ||
uses: actions/setup-python@v2 | ||
with: | ||
python-version: 3.8 | ||
- name: Install dependencies | ||
run: | | ||
pip install -e .[docs] | ||
- name: Build the documentation | ||
run: | | ||
cd docs | ||
make html | ||
touch _build/html/.nojekyll | ||
- name: Deploy documentation | ||
uses: JamesIves/github-pages-deploy-action@v4 | ||
with: | ||
folder: docs/_build/html | ||
token: ${{ secrets.GH_PAGES }} |