Update Docs (GH Pages) #469

	# SPDX-FileCopyrightText: 2024 geisserml <[email protected]>
	# SPDX-License-Identifier: Apache-2.0 OR BSD-3-Clause

	name: Update Docs (GH Pages)

	on:
	workflow_dispatch:
	workflow_call:
	# push:
	# branches:
	# - main
	# paths:
	# - docs/**
	# - src/**
	# - README.md

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

	# Allow one concurrent deployment
	concurrency:
	group: "pages"
	cancel-in-progress: true

	jobs:

	build:
	runs-on: ubuntu-latest

	steps:

	- name: Setup Python
	uses: actions/setup-python@v5
	with:
	python-version: '3.12'

	- name: Checkout
	uses: actions/checkout@v4
	with:
	repository: ${{ github.repository }}
	fetch-depth: 0 # quick fix for `git describe`

	- name: Install deps & pypdfium2
	run: \|
	python3 -m pip install -r req/docs.txt
	python3 -m pip install .

	- name: Build documentation
	run: ./run docs-build

	- name: Remove unnecessary files
	run: \|
	cd docs/build/html
	rm -rf .doctrees/

	- name: Upload artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: 'docs/build/html'

	publish:
	needs: build
	runs-on: ubuntu-latest

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

	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Provide feedback