Skip to content

feat: add quick start section to documentation and update installatio… #17

feat: add quick start section to documentation and update installatio…

feat: add quick start section to documentation and update installatio… #17

Workflow file for this run

name: Deploy Documentation
on:
push:
branches: [ main ]
workflow_dispatch:
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install uv
run: |
curl -LsSf https://astral.sh/uv/install.sh | sh
echo "$HOME/.cargo/bin" >> $GITHUB_PATH
- name: Install dependencies
run: |
uv pip install --system .
uv pip install --system ".[docs]"
- name: Build documentation
run: uv run task docs-build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site