update readme #132

	name: Build and deploy sphinx docs

	on:
	workflow_dispatch:
	push:
	branches:
	- main
	- 'stable/**'
	pull_request:
	branches:
	- main
	- 'stable/**'

	jobs:
	build_and_deploy_docs:
	runs-on: ubuntu-latest
	timeout-minutes: 60
	steps:
	- uses: actions/checkout@v4
	- uses: actions/setup-python@v4
	with:
	python-version: '3.9'
	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install tox
	sudo apt-get update
	sudo apt-get install -y pandoc
	- name: Build docs
	run: \|
	tox -edocs
	# - name: Deploy docs
	# if: ${{ github.ref == 'refs/heads/main' }}
	# uses: peaceiris/actions-gh-pages@v3
	# with:
	# github_token: ${{ secrets.GITHUB_TOKEN }}
	# publish_dir: ./docs/_build/html/

Provide feedback