Docs

add paper figure to readme #64

	name: Docs

	on:
	push:
	branches:
	- main
	# Add following in for testing
	# - feature/deploy_docs

	jobs:
	build:

	runs-on: ubuntu-latest
	strategy:
	matrix:
	python-version: [3.9]

	steps:
	- name: Checkout Source
	uses: actions/checkout@v2.3.1

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

	- name: Install package
	run: \|
	sudo apt install pandoc
	python -m pip install --upgrade pip
	pip install -r requirements/requirements-tests.txt
	pip install -r requirements/requirements-core.txt
	pip install -r requirements/requirements-docs.txt
	pip install .

	- name: Build Documentation
	run: \|
	cd docs && make html

	- name: Deploy
	if: github.ref == 'refs/heads/main'
	uses: JamesIves/github-pages-deploy-action@4.1.5
	with:
	branch: gh-pages # The branch the action should deploy to.
	folder: docs/_build/html # The folder the action should deploy.

Provide feedback