chore: update docs again (#77)

This commit is contained in:
lily-de
2024-09-25 14:20:49 -04:00
committed by GitHub
parent 31dfd48ac5
commit 4704b82bf1
77 changed files with 439 additions and 312 deletions

36
.github/workflows/deploy_docs.yaml vendored Normal file
View File

@@ -0,0 +1,36 @@
name: Deploy MkDocs
on:
push:
branches:
- main # Trigger deployment on pushes to main
paths:
- 'docs/**'
- 'mkdocs.yml'
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material
- name: Build the documentation
run: mkdocs build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site