Contributing

Tools

• uv manages dependencies and the Python virtualenv.

• pytest is the test handler for those in tests/

• ruff is the primary linter and formatter.

• pre-commit runs the linting and formatting steps before a commit.

Writing Documentation

Documentation is generated using Sphinx. Markup files are read from the docs/source/ directory and API documentation is built from the sigmazerosearch/ directory.

You can generate documentation from markup and Python docstrings and serve it locally using make docs.