colrev.plos package (#594) #162

	name: Deploy Sphinx documentation to GitHub Pages

	on:
	push:
	branches:
	- main

	permissions:
	contents: read
	id-token: write
	pages: write

	jobs:
	build:
	runs-on: ubuntu-latest

	steps:
	- name: Checkout repository
	uses: actions/checkout@v4

	- name: Set up Python
	uses: actions/setup-python@v2
	with:
	python-version: '3.10'

	- name: Set POETRY_CACHE_DIR
	run: echo "POETRY_CACHE_DIR=${{runner.temp}}/poetry_cache" >> $GITHUB_ENV
	- name: Install Poetry
	run: \|
	curl -sSL https://install.python-poetry.org \| python3 -
	echo "Poetry installed successfully"

	- name: Install dependencies
	run: \|
	poetry install -E docs --no-cache
	echo "Dependencies installed successfully"
	env:
	POETRY_VIRTUALENVS_CREATE: false
	POETRY_CACHE_DIR: .cache/poetry

	- name: Build documentation
	run: \|
	sphinx-build -b html docs/source _build/html
	echo "Documentation built successfully"

	- name: Upload Pages Artifact
	uses: actions/upload-pages-artifact@v3
	with:
	path: ./_build/html

	deploy:
	environment:
	name: github-pages
	url: ${{ steps.deployment.outputs.page_url }}
	runs-on: ubuntu-latest
	needs: build
	steps:
	- name: Deploy to GitHub Pages
	id: deployment
	uses: actions/deploy-pages@v4

Provide feedback