Skip to content

add docs

add docs #1

Workflow file for this run

name: Publish docs via GitHub Pages
on:
push:
branches:
- main
paths:
# Only rebuild website when docs have changed
- 'README.md'
- 'CHANGELOG.md'
- 'CONTRIBUTING.md'
- 'deployment/**'
- 'docs/**'
- '.github/workflows/deploy_mkdocs.yml'
jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v4
- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: 3.11
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install mkdocs mkdocs-material pygments
- name: Deploy docs
run: mkdocs gh-deploy --force -f docs/mkdocs.yml