Merge Paper branch (#43) #32

	# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
	# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

	name: docs

	on:
	push:
	branches: [ main ]

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

	steps:
	- uses: actions/checkout@v2

	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@v2
	with:
	python-version: ${{ matrix.python-version }}
	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install .[doc]

	- name: Build HTML docs
	id: linkcheck
	run: \|
	make -C docs html linkcheck 2>&1 \| tee check.log
	echo "::set-output name=broken::$(grep '(line\s[0-9])$\s$broken$\s$' check.log)"
	env:
	SPHINXOPTS: -nW --keep-going

	- name: Show docs build check results
	run: \|
	if [ -z "${{ steps.linkcheck.outputs.broken }}" ]; then
	echo "No broken links found."
	exit 0
	else
	echo "Broken links found:"
	echo "${{ steps.linkcheck.outputs.broken }}"
	exit 1
	fi

	- name: Deploy
	uses: peaceiris/actions-gh-pages@v3
	# Deply the documentation built only on the push even
	if: ${{ (github.event_name != 'pull_request') && (github.repository == 'SMTG-Bham/easyunfold') }}
	with:
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: ./docs/_build/html

Provide feedback