FIREFLY-1862: Cleanup the firefly-client docs and example notebooks #24

	name: "Publish documentation"
	on:
	push:
	branches:
	- master

	pull_request:
	branches:
	- master

	workflow_dispatch: # Manual trigger

	jobs:
	build:
	runs-on: ubuntu-latest

	steps:
	- uses: actions/checkout@v4

	- name: Install system dependencies (pandoc)
	run: \|
	sudo apt-get update
	sudo apt-get install -y pandoc

	- uses: actions/setup-python@v5
	with:
	python-version: '3.10'
	cache: 'pip'

	- name: Create environment
	run: \|
	pip install --upgrade pip
	python -m venv .venv
	source .venv/bin/activate

	- name: Install the package with docs dependencies
	run: pip install -e .[docs]

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

	# Deploy stable docs (root of gh-pages) only from master pushes
	- name: Deploy docs (stable)
	if: github.event_name == 'push' && github.ref == 'refs/heads/master'
	uses: peaceiris/actions-gh-pages@v3
	with:
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: ./docs/_build/html

	# Deploy PR preview docs to gh-pages under pr/<number>/
	- name: Deploy docs (PR preview)
	if: github.event_name == 'pull_request'
	uses: peaceiris/actions-gh-pages@v3
	with:
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: ./docs/_build/html
	destination_dir: pr/${{ github.event.pull_request.number }}
	keep_files: true

	- name: Print PR preview URL
	if: github.event_name == 'pull_request'
	run: \|
	echo "Deployed PR docs preview at: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/pr/${{ github.event.pull_request.number }}/"

Provide feedback