enh: deploy mkdocs doc to github page on repo #1

	name: Deploy MkDocs to GitHub Pages

	on:
	push:
	branches:
	- main
	- docs/add-mkdocs-documentation

	env:
	python-version: "3.10"

	jobs:
	deploy-docs:
	name: Deploy docs
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v3

	- name: Set up Python ${{ env.python-version }}
	uses: actions/setup-python@v4
	with:
	python-version: ${{ env.python-version }}

	- name: Install poetry
	run: make download-poetry

	- name: Set up pip cache
	uses: actions/[email protected]
	with:
	path: ~/.cache/pypoetry/virtualenvs
	key: venv-${{ env.python-version }}-${{ hashFiles('pyproject.toml') }}-${{ hashFiles('poetry.lock') }}

	- name: Set Poetry Path
	run: \|
	echo "$HOME/.poetry/bin" >> $GITHUB_PATH


	- name: Install requirements
	run: \|
	poetry run pip install --upgrade pip
	poetry install

	- name: Deploying MkDocs documentation
	run: \|
	mkdocs build
	mkdocs gh-deploy --force

Provide feedback