Docs

[pre-commit.ci] pre-commit autoupdate (#523) #14

	name: Docs

	on:
	# Runs on pushes targeting the default branch
	push:
	branches:
	- main
	pull_request:
	branches:
	- main

	# Allows you to run this workflow manually from the Actions tab
	workflow_dispatch:

	# Allow one concurrent deployment
	concurrency:
	group: pages-${{ github.workflow }}-${{ github.event.pull_request.number }}
	cancel-in-progress: true

	jobs:
	docs:
	runs-on: ubuntu-latest
	defaults:
	run:
	shell: bash -el {0}
	steps:
	- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 #v7.0.0

	- uses: conda-incubator/setup-miniconda@8ee1f361103df19b6f8c8655fd3967a8ecb162d5 #v4.0.1
	with:
	activate-environment: menuinst-docs
	environment-file: docs/environment.yml
	python-version: '3.11'
	auto-activate-base: false

	- name: Build Documentation
	run: \|
	pip install -e .
	cd docs
	make dirhtml SPHINXOPTS="-W --keep-going -n"

	- name: Upload artifact
	uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 #v5.0.0
	with:
	# Upload entire repository
	path: 'docs/_build/dirhtml'

	- name: Check links
	run: \|
	cd docs
	make linkcheck

	pages:
	runs-on: ubuntu-latest
	if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main'
	needs: [docs]

	# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
	permissions:
	contents: read
	pages: write
	id-token: write

	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}

	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 #v5.0.0

Provide feedback