[pull] main from pretalx:main #359

	# SPDX-FileCopyrightText: 2020-present Tobias Kunze
	# SPDX-License-Identifier: Apache-2.0

	name: Documentation

	on:
	push:
	branches: [ main ]
	paths:
	- 'doc/**'
	- 'pyproject.toml'
	pull_request:
	branches: [ main ]
	paths:
	- 'doc/**'
	- 'pyproject.toml'

	concurrency:
	group: ${{ github.workflow }}-${{ github.head_ref \|\| github.run_id }}
	cancel-in-progress: true

	jobs:
	build:
	name: Build
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v7
	- uses: actions/setup-python@v7
	with:
	python-version-file: ".github/workflows/python-version.txt"
	- name: Enable caching
	uses: astral-sh/setup-uv@v7
	with:
	enable-cache: true
	- uses: extractions/setup-just@v4
	- name: Install Dependencies
	run: just install --extra devdocs
	- name: Docs build without warnings
	run: just docs-build dirhtml -W

	linkcheck:
	name: Linkcheck
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v7
	- uses: actions/setup-python@v7
	with:
	python-version-file: ".github/workflows/python-version.txt"
	- name: Enable caching
	uses: astral-sh/setup-uv@v7
	with:
	enable-cache: true
	- uses: extractions/setup-just@v4
	- name: Install Dependencies
	run: just install --extra devdocs
	- name: Linkcheck docs
	run: just docs-linkcheck
	- name: Put linkcheck result into summary
	run: \|
	echo "## Linkcheck results" >> $GITHUB_STEP_SUMMARY
	grep -v "redirected with Found" _build/linkcheck/output.txt \| sed 's/^/- /' >> $GITHUB_STEP_SUMMARY
	echo "" >> $GITHUB_STEP_SUMMARY
	working-directory: ./doc
	if: always()

Navigation Menu