Skip to content
Documentation

update docs #16

Sign in to view logs

update docs

update docs #16

Workflow file for this run

.github/workflows/documentation.yml at 1403597
name: Documentation
on:
push:
branches:
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Configure Git
run: |
git config --global user.name "github-actions[bot]"
git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.12"
- name: Install dependencies
run: |
pip install mkdocs-material
pip install mkdocstrings[python]
pip install .
- name: Setup docs directory
run: |
cd docs
ln -sf ../README.md .
- name: Deploy documentation
run: mkdocs gh-deploy --force