Skip to content

Commit

Permalink
docs: setup github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
jurra committed Sep 25, 2023
1 parent 2432f0f commit b5c723c
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
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 jupyterbook
required: False
default: ""

# This job installs dependencies, builds the documentaiton, and pushes it to `gh-pages`
jobs:
deploy-book:
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 .[dev]
- 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

0 comments on commit b5c723c

Please sign in to comment.