Requirements

Runtime Requirements

  • Python 3.10 or newer.

  • Sphinx 8.0 or newer.

Development Requirements

If you want to work on this extension, all required dependencies are listed in the requirements-dev.txt file. You need Python 3.12 or newer for development.

You can install them with:

pip install -r requirements-dev.txt

The development dependencies include:

  • pytest Used to run the unit tests.

  • black Automatically formats the code to ensure consistent style.

  • hatch Tool for building, managing, and publishing the package.

  • hatch-vcs Hatch extension that integrates version control metadata into builds.