Skip to content

Commit

Permalink
add autodeployment of docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Kieran B. Spooner committed Mar 18, 2024
1 parent e1f6059 commit 5714915
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ name: docs
on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]

permissions:
contents: read
Expand All @@ -25,8 +23,12 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx_rtd_theme
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
pip install -e '.[docs]'
- name: Build docs with sphinx
run: |
cd docs; sphinx-build -b html src/ .
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/src/

0 comments on commit 5714915

Please sign in to comment.