Skip to content

Update README, removing parts now in the user guide and adding links … #3

Update README, removing parts now in the user guide and adding links …

Update README, removing parts now in the user guide and adding links … #3

Workflow file for this run

name: Docs Build
on:
push:
# TODO change branch to main once docs is merged
branches: [ docs ]
# Manual trigger, as you have — you can also add "push" later if desired
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 10 # give yourself more headroom for builds
steps:
- name: Checkout
uses: actions/checkout@v4 # use latest v4 instead of v3
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.11
- name: Install uv
run: pip install uv
- name: Cache dependencies
uses: actions/cache@v4
with:
path: ~/.cache/uv
key: uv-${{ hashFiles('pyproject.toml') }}
- name: Install dependencies
run: |
uv venv
uv pip install -e ".[dev]"
- name: Build docs
run: uv run poe doc-build
# TODO: change once errors are resolved
continue-on-error: true
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/_build # ✅ confirm this is your static HTML output directory
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4