Skip to content

docs: cleanup readme and action #5

docs: cleanup readme and action

docs: cleanup readme and action #5

Workflow file for this run

name: Docs
on:
push:
branches: [main]
pull_request:
workflow_dispatch:
jobs:
docs:
runs-on: ubuntu-latest
permissions: "write-all"
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.10"
cache: pip
cache-dependency-path: pyproject.toml
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install wheel setuptools
pip install -e .
pip install mkdocs mkdocs-material "mkdocstrings[python]" mkdocs-autorefs
- name: Build
run: mkdocs build
- run: mkdocs gh-deploy --force