Update 2025_ps.md (#215) #229
This file contains hidden or 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
# Build documentation and upload to gh-pages | |
name: Build and upload documentation | |
defaults: | |
run: | |
shell: bash | |
env: | |
UV_COMPILE_BYTECODE: 1 | |
on: # Runs on any push event to master | |
push: | |
branches: | |
- master | |
jobs: | |
documentation: | |
name: Build and Publish Static Documentation | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Install uv and Python | |
uses: astral-sh/setup-uv@v6 | |
with: | |
python-version: 3.13 | |
enable-cache: true | |
activate-environment: true | |
cache-dependency-glob: "requirements.txt" | |
- name: Install dependencies | |
run: uv pip install -r requirements.txt | |
- name: Build documentation | |
run: python -m mkdocs build -d ./doc_build | |
- name: Upload documentation to gh-pages | |
uses: JamesIves/github-pages-deploy-action@v4 | |
if: success() | |
with: | |
token: ${{ secrets.GITHUB_TOKEN }} | |
branch: gh-pages | |
folder: doc_build |