Build Documentation and Push to gh-pages Branch #23

	# This pipeline
	# - builds developer documentation
	# - pushes documentation to gh-pages branch of the same repository
	#
	# Deployment is handled by pages-build-deployment bot

	name: Build Documentation and Push to gh-pages Branch

	# Controls when the workflow will run
	on:
	# Triggers the workflow on tag creation
	push:
	tags:
	- 'v*'

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

	# A workflow run is made up of one or more jobs that can run sequentially or in parallel
	jobs:
	# This workflow contains a single job called "build"
	build_documentation:
	runs-on: ubuntu-latest
	steps:
	- name: Checkout
	uses: actions/checkout@master
	with:
	fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
	- name: Upgrade pip
	run: \|
	python -m pip install --upgrade pip
	- name: Force upgrade of sphinx-rtd-theme to build documentation, not compatible with docutils 0.20.1
	run: \|
	pip install --upgrade --force-reinstall sphinx-rtd-theme
	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: 3.9
	- name: Install Pandoc, repo and dependencies
	run: \|
	sudo apt install pandoc
	pip install . '.[dev,docs]'
	- name: Build and Commit
	uses: sphinx-notes/pages@master
	with:
	install_requirements: true
	documentation_path: docs/src
	- name: Push changes
	uses: ad-m/github-push-action@master
	continue-on-error: true
	with:
	github_token: ${{ secrets.CORE_TOKEN }}
	branch: gh-pages

Provide feedback