Skip to content

chore: upgrade to 0.6.3 #67

chore: upgrade to 0.6.3

chore: upgrade to 0.6.3 #67

Workflow file for this run

name: Deploy Documentation
on:
push:
branches:
- main
pull_request:
branches:
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: Install dependencies
run: |
pip install --upgrade pip
pip install mkdocs mkdocs-material mkdocs-material-extensions
pip install "mkdocstrings[python]>=0.24.0" mkdocstrings-python>=1.7.0
pip install pyyaml # For generate_api_docs.py
- name: Generate API reference docs
run: python3 scripts/generate_api_docs.py
- name: Build documentation
run: mkdocs build
- name: Deploy to GitHub Pages
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site