Skip to content

update docs

update docs #4

Workflow file for this run

name: Test Documentation Build
on:
push:
branches:
- main
paths:
- 'docs/**'
- 'mkdocs.yml'
pull_request:
branches:
- main
paths:
- 'docs/**'
- 'mkdocs.yml'
jobs:
test:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material mkdocs-minify-plugin mkdocstrings[python]
- name: Build documentation
run: mkdocs build --clean
- name: Check build artifacts
run: |
ls -la site/
echo "Documentation build successful!"