docs

bench: clustering producers for clusTCR, GIANA, iSMART, DeepTCR #30

	name: docs

	on:
	push:
	branches: [dev, master]
	workflow_dispatch:

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

	# Per-ref so a dev push never cancels an in-flight master Pages deploy.
	concurrency:
	group: pages-${{ github.ref }}
	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 docs toolchain
	# autodoc imports vdjmatch with heavy deps (seqtree, polars) mocked in docs/conf.py,
	# so the native seqtree toolchain is not needed to build docs.
	run: pip install sphinx pydata-sphinx-theme nbsphinx ipython
	- name: Build HTML (fail on warnings)
	run: sphinx-build -W --keep-going -b html docs docs/_build/html
	- uses: actions/upload-pages-artifact@v3
	with:
	path: docs/_build/html

	deploy:
	needs: build
	# The github-pages environment only allows deploys from the default branch; on dev we
	# validate the build (above) but skip deployment so the workflow stays green.
	if: github.ref == 'refs/heads/master'
	runs-on: ubuntu-latest
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- id: deployment
	uses: actions/deploy-pages@v4

Provide feedback