Docs

Add visualization documentation page with panel-by-panel walkthrough #9

	name: Docs

	on:
	push:
	branches: [main]
	workflow_dispatch:

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

	concurrency:
	group: pages
	cancel-in-progress: true

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v4

	- uses: actions/setup-python@v5
	with:
	python-version: "3.12"

	- name: Install dependencies
	run: \|
	pip install --upgrade pip
	# Install doc tools directly (not via .[docs]) because the package
	# requires Python 3.10 while the doc build uses 3.12.
	pip install sphinx "python-docs-theme>=2025.1" "myst-parser>=3.0" sphinx-autodoc-typehints sphinx-design
	pip install pandas matplotlib numpy

	- name: Build HTML
	run: sphinx-build docs docs/_build/html

	- uses: actions/upload-pages-artifact@v3
	with:
	path: docs/_build/html

	deploy:
	needs: build
	runs-on: ubuntu-latest
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- id: deployment
	uses: actions/deploy-pages@v4

Navigation Menu