This repository was archived by the owner on Apr 23, 2025. It is now read-only.

Archiving #587

	name: Build the documentation

	on:
	push:
	branches: [main]
	pull_request:
	branches: [main]

	jobs:
	build:
	# Functionality for testing documentation builds on multiple OSes and Python versions
	name: Build docs (${{ matrix.python-version }}, ${{ matrix.os }})
	runs-on:
	group: fortuna
	labels: fortuna_ubuntu-latest_32-core
	defaults:
	run:
	shell: bash -l {0}
	strategy:
	matrix:
	os: ["ubuntu-latest"]
	python-version: ["3.11"]

	steps:
	# Grap the latest commit from the branch
	- name: Checkout the branch
	uses: actions/[email protected]
	with:
	persist-credentials: false

	# Add this step to set up Python version from matrix
	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@v2
	with:
	python-version: ${{ matrix.python-version }}

	# Install Poetry and build the documentation
	- name: Install and configure Poetry
	uses: snok/install-poetry@v1
	with:
	version: 1.8.3
	virtualenvs-create: true
	virtualenvs-in-project: false
	installer-parallel: true
	env:
	POETRY_VIRTUALENVS_PREFER_ACTIVE_PYTHON: "true"

	- name: Build the documentation with Sphinx
	run: \|
	poetry env use ${{ matrix.python-version }}
	poetry install --all-extras
	sudo apt install pandoc
	pip install pandoc
	cd docs
	poetry run sphinx-build -b html source build/html

Provide feedback