Repository navigation

Version 0.2.0 (#74) #63

	name: Deploy docs to GitHub Pages

	on:
	push:
	branches: ["devel", "main"] # TODO: Set to main only after release
	workflow_dispatch:

	permissions:
	contents: read
	pages: write
	id-token: write

	concurrency:
	group: "pages"
	cancel-in-progress: false

	jobs:
	build-and-deploy:
	runs-on: ubuntu-latest
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}

	steps:
	- name: Checkout
	uses: actions/checkout@v4

	- name: Install pandoc and LaTeX
	run: \|
	sudo apt-get update
	sudo apt-get install -y pandoc
	# pdflatex with pgfplots: the tutorials compile tikzfigure figures
	sudo apt-get install -y --no-install-recommends \
	texlive-latex-base texlive-latex-extra texlive-pictures \
	texlive-fonts-recommended lmodern

	- name: Install Python dependencies
	run: \|
	python -m pip install --upgrade pip
	# tikzfigure 0.4.0 is not on PyPI yet: install it from GitHub (drop once released)
	pip install "tikzfigure[vis] @ git+https://github.com/max-models/tikzfigure@c290f43ac1deb4a4ed3b5b40919f10d3a6b53e8b"
	pip install ".[docs]"

	- name: Build Sphinx docs
	run: \|
	cd docs
	make html

	- name: Setup Pages
	uses: actions/configure-pages@v5

	- name: Upload built docs
	uses: actions/upload-pages-artifact@v3
	with:
	path: docs/build/html/

	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4