Contributing

Set up your environment

Clone the repository.
Create a virtual environment with python 3.12 or newer.
Install Sphinx Vhs in development mode, and install dev dependencies:
```
pip install -e . --group dev
```
Install pre-commit hooks:
```
pre-commit install
```

To run tests, simply run pytest and pyright:

pytest  # Run unit tests.
pyright  # Run type check.

To fix code style, you can manually run pre-commit hooks:

pre-commit run -a  # Fix code style.

Just run sphinx as usual, nothing special is required:

cd docs/
make html

Update changelog.md. Make sure to update links at the end of the file.

Changelog must have a section for the new release, otherwise the build will fail.
Push a git tag. You'll need a repository admin role to do so.

All tags should start with prefix v, and follow semantic versioning guidelines. This, among other things, means that tags for beta-, post-, etc. releases should have form v1.0.0-beta0 instead of Python's v1.0.0b0.
From here, release happens automatically. PyPi package will be uploaded from CI job, and documentation will be updated by Read the Docs build.