Repository navigation

Docs

Cover automatic HF and Lightning two-rank launches #363

	name: Docs

	on:
	push:
	branches: [main]
	paths:
	- 'docs/**'
	- 'tests/docs/**'
	- '.github/workflows/docs.yml'
	- '*.md'
	- 'mkdocs.yml'
	- 'pyproject.toml'
	pull_request:
	# PRs in this repo target release branches (version_*) day to day and
	# main only for the batch merge; the docs check must run on both.
	branches: [main, 'version_*']
	paths:
	- 'docs/**'
	- 'tests/docs/**'
	- '.github/workflows/docs.yml'
	- '*.md'
	- 'mkdocs.yml'
	- 'pyproject.toml'

	concurrency:
	group: docs-${{ github.ref }}
	cancel-in-progress: ${{ github.event_name == 'pull_request' }}

	jobs:
	build:
	runs-on: ubuntu-latest
	permissions:
	contents: read
	steps:
	- uses: actions/checkout@v4
	with:
	fetch-depth: 0

	- uses: actions/setup-python@v5
	with:
	python-version: "3.10"
	cache: pip
	cache-dependency-path: pyproject.toml

	- name: Install dependencies
	run: pip install -e ".[docs,torch,lightning,hf]" pytest

	- name: Verify integration support evidence
	run: python tools/integration_support_matrix.py --check

	- name: Test published documentation
	run: pytest -q tests/docs

	- name: Build documentation
	run: mkdocs build --strict

	- uses: actions/upload-pages-artifact@v3
	with:
	path: site

	deploy:
	needs: build
	if: github.ref == 'refs/heads/main'
	runs-on: ubuntu-latest
	permissions:
	pages: write
	id-token: write
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	steps:
	- id: deployment
	uses: actions/deploy-pages@v4