Docs

Add more examples #38

	name: Docs

	on:
	push:
	branches: [main, dev]
	tags: ["v..*"]
	pull_request:
	types: [opened, reopened, synchronize, ready_for_review]

	permissions:
	contents: write

	jobs:
	test-build-docs:
	runs-on: ubuntu-latest

	steps:
	- uses: actions/checkout@v3
	- name: Install poetry
	run: pipx install poetry
	- uses: actions/setup-python@v4
	with:
	python-version: "3.10"
	cache: "poetry"

	- name: Check that documentation builds without errors
	run: \|
	poetry install --with docs
	poetry run poe docs
	deploy:
	needs: [test-build-docs]
	if: github.event_name == 'push'
	runs-on: ubuntu-latest
	steps:
	- name: Install poetry
	run: pipx install poetry
	- 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: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
	- uses: actions/cache@v4
	with:
	key: mkdocs-material-${{ env.cache_id }}
	path: .cache
	restore-keys: \|
	mkdocs-material-
	- run: poetry install --only docs

	- run: poetry run mkdocs gh-deploy --force

Provide feedback