docs and readme #2

	name: "Documentation"

	on:
	push:
	branches:
	- develop
	- master
	schedule:
	- cron: '37 23 * * 2'

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

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

	jobs:
	generate:
	name: Generate
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4
	- name: Install mdBook
	run: \|
	sudo apt-get install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
	pip install \
	"cairosvg>=2.7.1"\
	"markupsafe>=2.1.5"\
	"mdx-gh-links>=0.4"\
	"mkdocs-autolinks-plugin>=0.7.1"\
	"mkdocs-awesome-pages-plugin>=2.9.3"\
	"mkdocs-click>=0.8.1"\
	"mkdocs-ezglossary-plugin>=1.6.10"\
	"mkdocs-ezlinks-plugin>=0.1.14"\
	"mkdocs-gen-files>=0.5.0"\
	"mkdocs-get-deps>=0.2.0"\
	"mkdocs-include-markdown-plugin>=6.2.2"\
	"mkdocs-link-marker>=0.1.3"\
	"mkdocs-macros-plugin>=1.0.5"\
	"mkdocs-material[imaging]>=9.5.15"\
	"mkdocs-minify-plugin"\
	"mkdocs-redirects"\
	"mkdocs-simple-hooks>=0.1.5"\
	"mkdocs>=1.5.3"\
	"mkdocstrings[python]>=0.24.1"\
	"pymdown-extensions>=10.7.1"

	mkdocs build -d ./docs-output
	- name: Upload artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: ./docs-output

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

Provide feedback