Skip to content

Commit

Permalink
Adding in a docs workflow to publish to new branch
Browse files Browse the repository at this point in the history
  • Loading branch information
kallewesterling committed Feb 7, 2024
1 parent d6adb8b commit 6190e6d
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Docs
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v2
with:
python-version: 3.11
- uses: nikeee/setup-pandoc@v1
- name: "Upgrade pip"
run: pip install --upgrade pip
- name: "Install jupyterbook"
run: pip install -r docs/requirements.docs.txt
- name: "Run jupyterbook"
run: jupyter-book build docs --all
- name: "Deploy"
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/docs') }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html/
force_orphan: true

0 comments on commit 6190e6d

Please sign in to comment.