Update readme to reflect complete state (#154) #19

	name: Deploy docs to Pages

	on:
	# Runs on pushes targeting the default branch
	push:
	branches: ["main"]

	# Allows you to run this workflow manually from the Actions tab
	workflow_dispatch:

	# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
	permissions:
	contents: read
	pages: write
	id-token: write

	# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
	# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
	concurrency:
	group: "pages"
	cancel-in-progress: false

	jobs:
	deploy:
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	runs-on: ubuntu-latest
	steps:
	- name: Checkout
	uses: actions/checkout@v4
	- name: Set up Python 3.10
	uses: actions/setup-python@v3
	with:
	python-version: "3.10"
	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	python -m pip install -r docs/requirements.txt
	- name: Build
	run: \|
	jupyter-book build docs
	- name: Setup Pages
	uses: actions/configure-pages@v4
	- name: Upload artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: './docs/_build/html/'
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Provide feedback