Merge branch '22-add-documentation' of https://github.com/saezlab/net… #25

	name: Sphinx build docs on push
	on:
	- push

	jobs:
	build:
	runs-on: ubuntu-latest
	steps:
	- name: Check out main
	uses: actions/checkout@main
	- name: Setup Python
	uses: actions/setup-python@v5
	- name: Load cached Poetry installation
	uses: actions/cache@v4
	with:
	path: ~/.local
	key: poetry-0
	- name: Install Poetry
	uses: snok/install-poetry@v1
	with:
	virtualenvs-create: true
	virtualenvs-in-project: true
	installer-parallel: true
	- name: Load cached venv
	id: cached-poetry-dependencies
	uses: actions/cache@v4
	with:
	path: .venv
	key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
	- name: Install dependencies
	if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
	run: poetry install --no-interaction --no-root
	- name: Install library
	run: poetry install --no-interaction
	- name: Build documentation
	run: poetry run make html --directory docs/
	- name: Commit files
	run: \|
	git config --local user.email "[email protected]"
	git config --local user.name "GitHub Action"
	touch docs/_build/html/.nojekyll
	git add -f docs/_build/
	git commit -m "Update autodoc" -a
	# using https://github.com/marketplace/actions/push-git-subdirectory-as-branch
	- name: Deploy
	uses: s0/git-publish-subdir-action@develop
	env:
	REPO: self
	BRANCH: gh-pages
	FOLDER: docs/_build/html
	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Provide feedback