Documentation #30

	name: Documentation

	on:
	release:
	types: [created]

	jobs:
	build-docs:
	runs-on: ubuntu-latest

	steps:
	- uses: actions/checkout@v4
	with:
	fetch-depth: 0 # Fetch all history for all tags and branches
	ref: ${{ github.event.release.tag_name }}

	- name: Set up Python
	uses: actions/setup-python@v5
	with:
	python-version: '3.11'

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

	- name: Build documentation
	run: \|
	cd docs
	make html

	- name: Upload documentation artifacts
	uses: actions/upload-artifact@v4
	with:
	name: documentation-html
	path: docs/build/html/

	- name: Deploy to GitHub Pages
	if: github.event_name == 'release'
	uses: peaceiris/actions-gh-pages@v4
	with:
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: docs/build/html
	publish_branch: gh-pages

Navigation Menu