Skip to content

Commit

Permalink
add docs workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
pattonw committed Mar 10, 2025
1 parent 8419af6 commit 427044c
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Generate Pages

on:
push:
branches:
- update-docs

jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Install uv
uses: astral-sh/setup-uv@v5

- name: parse notebooks
run: |
uv run --extra [docs] jupytext --to notebook --execute ./docs/source/notebooks/tutorial.py --output ./docs/source/notebooks/tutorial.ipynb
- name: remove notebook scripts
run: rm ./docs/source/notebooks/*.py
- name: Build and Commit
uses: sphinx-notes/pages@v3
with:
documentation_path: ./docs/source
- name: Push changes
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages

0 comments on commit 427044c

Please sign in to comment.