docs

docs: setup mkdocs for documentation publishing #1

	name: docs

	on:
	push:
	branches: ['main']
	workflow_dispatch:

	permissions:
	contents: read
	pages: write
	id-token: write

	concurrency:
	group: "pages"
	cancel-in-progress: false

	jobs:
	build:
	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 mkdocs
	run: python -m pip install mkdocs "mkdocstrings[python]" mkdocs-material
	- name: Setup caching
	uses: actions/cache@v4
	with:
	key: ${{ github.sha }}
	path: .cache
	- name: Build site
	run: mkdocs build
	- name: Upload artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: ./site

	deploy:
	needs: build
	runs-on: ubuntu-latest
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Provide feedback