add mkdocs

Initial commit of a mkdocs based docs setup
This commit is contained in:
Timothy Pillow 2024-12-21 16:36:07 +01:00 • committed by GitHub
parent 7d64a47b88
commit 50fa7ac694
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
42 changed files with 2923 additions and 0 deletions

23
.github/workflows/mkdocs.yml vendored Normal file
View file

@ -0,0 +1,23 @@
name: "mkdocs"
on:
push:
branches:
- master
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: pip install -r requirements.txt
working-directory: ./mkdocs
- run: mkdocs gh-deploy --force
working-directory: ./mkdocs