Add all missing functions to "Usage" introduction in README.md #58

	# Generate Sphinx documentation and upload it to GitHub Pages

	name: Sphinx documentation

	on:
	push:
	branches: [ "main" ]
	pull_request:
	branches: [ "main" ]
	workflow_dispatch:

	permissions:
	contents: write

	jobs:
	docs:
	name: Update documentation
	runs-on: ubuntu-latest
	steps:
	- uses: actions/checkout@v6
	- name: "Install Python"
	uses: actions/setup-python@v6
	with:
	python-version-file: "pyproject.toml"
	- name: Install uv
	uses: astral-sh/setup-uv@v7
	- name: Install the project
	run: uv sync --locked --all-extras --dev
	- name: Sphinx build
	run: uv run --dev sphinx-build docs docs/build
	- name: Deploy to GitHub Pages
	uses: peaceiris/actions-gh-pages@v3
	if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
	with:
	publish_branch: gh-pages
	github_token: ${{ secrets.GITHUB_TOKEN }}
	publish_dir: docs/build/
	force_orphan: true

Navigation Menu