-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add GitHub Actions workflow for building and deploying documentation
- Loading branch information
1 parent
b7768e0
commit c1c56b2
Showing
1 changed file
with
29 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,29 @@ | ||
name: Build and Deploy Documentation | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
workflow_dispatch: # This allows manual triggering of the workflo | ||
jobs: | ||
build-and-deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout the code | ||
uses: actions/checkout@v3 | ||
- name: Install the latest version of uv | ||
uses: astral-sh/setup-uv@v3 | ||
- name: Install Python | ||
run: uv python install | ||
- name: Setup, Lint, and Test Python | ||
run: | | ||
uv sync --extra dev --extra sparse --extra samples | ||
source .venv/bin/activate | ||
- name: Build the Sphinx documentation | ||
working-directory: ./doc | ||
run: make html | ||
- name: Deploy to GitHub Pages | ||
uses: peaceiris/actions-gh-pages@v3 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
publish_dir: doc/build/html |