Release v1.4.1 and restore start-only keypress #22

	name: Docs site

	# Build the MkDocs Material site from main and publish it to the
	# gh-pages branch. The GitHub Pages settings should be configured to
	# serve from "gh-pages branch / (root)".

	on:
	push:
	branches: [main]
	paths:
	- "mkdocs.yml"
	- "docs/**"
	- "images/**"
	- "requirements-docs.txt"
	- ".github/workflows/docs.yml"
	workflow_dispatch:

	permissions:
	contents: write # needed to push the built site to gh-pages

	concurrency:
	group: docs-${{ github.ref }}
	cancel-in-progress: true

	jobs:
	build-and-deploy:
	name: Build and deploy MkDocs site
	runs-on: ubuntu-latest
	steps:
	- name: Check out repository
	uses: actions/checkout@v4
	with:
	fetch-depth: 0 # mkdocs-material's git-revision-date wants full history

	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: "3.12"
	cache: pip

	- name: Install documentation dependencies
	run: \|
	python -m pip install --upgrade pip
	python -m pip install -r requirements-docs.txt

	- name: Build site
	# Not using --strict because (1) USER_GUIDE.md / USER_GUIDE.ja.md
	# cross-link each other via plain markdown links that the i18n
	# plugin treats as broken (the language switcher handles this at
	# runtime anyway), and (2) USER_GUIDE references ../CITATION.cff
	# which lives outside docs_dir and is intentionally absolute.
	run: mkdocs build

	- name: Deploy to gh-pages
	run: \|
	python -m pip install ghp-import
	ghp-import \
	--no-jekyll \
	--branch gh-pages \
	--message "Deploy docs site (${GITHUB_SHA::7})" \
	--push \
	site

Navigation Menu