add docs

tlambert03 · tlambert03 · commit 0d231cccf93d · 2025-04-25T08:08:06.000-04:00
diff --git a/src/scyjava/_stubs/_hatchling.py b/src/scyjava/_stubs/_hatchling.py
@@ -1,7 +1,23 @@
-"""Hatchling build hook for generating Java stubs."""
+"""Hatchling build hook for generating Java stubs.
+
+To use this hook, add the following to your `pyproject.toml`:
+
+```toml
+[build-system]
+requires = ["hatchling", "scyjava"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.hooks.scyjava]
+maven_coordinates = ["org.scijava:parsington:3.1.0"]
+prefixes = ["org.scijava"]  # optional ... can be auto-determined from the jar files
+```
+
+This will generate stubs for the given maven coordinates and prefixes. The generated
+stubs will be placed in `src/scyjava/types` and will be included in the wheel package.
+This hook is only run when building a wheel package.
+"""
 
 import logging
-import shutil
 from pathlib import Path
 
 from hatchling.builders.hooks.plugin.interface import BuildHookInterface
