This repository has been archived by the owner on Dec 8, 2024. It is now read-only.

docs: add instructions for building documentation locally #3

	# REF: https://coderefinery.github.io/documentation/gh_workflow/

	name: Build documentation


	on: [push, pull_request, workflow_dispatch]

	env:
	PYTHON_VERSION: '3.10'
	POETRY_VERSION: '1.8.3'

	permissions:
	contents: write

	jobs:
	docs:
	runs-on: ubuntu-22.04
	steps:
	- name: Checkout repository
	uses: actions/checkout@v4

	# Local action that tries to cache as much of python & poetry as possible
	- name: Setup environment
	uses: ./.github/workflows/setup-python
	with:
	python-version: ${{ env.PYTHON_VERSION }}
	poetry-version: ${{ env.POETRY_VERSION }}

	- name: Sphinx build
	run: \|
	cd docs && poetry run make html
	- name: Deploy to GitHub Pages
	uses: peaceiris/actions-gh-pages@v3
	if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
	with:
	publish_branch: gh-pages
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: _build/
	force_orphan: true

Provide feedback