Docs

[pre-commit.ci] pre-commit autoupdate #389

	name: Docs

	on:
	push:

	jobs:
	deploy:
	runs-on: ubuntu-latest
	strategy:
	matrix:
	python-version: ["3.12"]
	permissions:
	contents: write
	concurrency:
	group: ${{ github.workflow }}-${{ github.ref }}


	steps:
	- uses: actions/checkout@v3
	- name: Set up Python ${{ matrix.python-version }}
	uses: actions/setup-python@v3
	with:
	python-version: ${{ matrix.python-version }}
	- name: Install and configure poetry
	uses: snok/install-poetry@v1
	with:
	virtualenvs-create: true
	virtualenvs-in-project: true
	- name: Load cached venv
	id: cached-pip-wheels
	uses: actions/cache@v3
	with:
	path: ~/.cache
	key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
	- name: Install dependencies
	run: poetry install --no-interaction --no-root --with analysis,docs
	if: steps.cache.outputs.cache-hit != 'true'
	- name: Install project
	run: poetry install --no-interaction ${{ inputs.poetry-extras }}


	- name: Compile documentation
	run: \|
	sudo apt-get update
	sudo apt-get install python3-sphinx
	source $VENV
	make -C docs html


	- name: Deploy
	uses: peaceiris/actions-gh-pages@v3

	if: github.ref == 'refs/heads/main'
	with:
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: '**/docs/build/html'

Navigation Menu