summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCharles Roelli <charles@adnoto.net>2026-02-06 10:33:44 +0100
committerCharles Roelli <charles@adnoto.net>2026-02-06 10:33:44 +0100
commitada1d675ddda548800307f48a14a95062ced7efa (patch)
tree837102b2be3efcc97ab4ff444f213d29912f8a7f /README.md
parent951800fd37c5f77df8a011787be184de2731836d (diff)
Document all features, new output-directory option
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/README.md b/README.md
index 317ca1f..53a8253 100644
--- a/README.md
+++ b/README.md
@@ -3,9 +3,9 @@
Collect a django project's static files into its binary distribution
archive.
-Example usage:
+Example usage in `pyproject.toml`:
-```
+```toml
[build-system]
requires = ["hatchling >= 1.26", "hatch-django-collectstatic"]
build-backend = "hatchling.build"
@@ -13,6 +13,21 @@ build-backend = "hatchling.build"
[tool.hatch.build.targets.wheel.hooks.django-collectstatic]
settings = "my_django_package.project.settings"
+# If you have installed Django apps from packages besides Django,
+# you'll need to enable the require-runtime-dependencies feature of
+# hatch in order to make these packages available when collecting
+# static files.
+# Default value of require-runtime-dependencies = false
+# require-runtime-dependencies = true
+
+# Output directory where static files are collected in the target.
+# Default value of output-directory = "static"
+# output-directory = "custom-static-directory"
+
[tool.hatch.build.targets.wheel.shared-data]
+# Mapping from output directory to the distribution path. The
+# following configuration will place the files in the .data directory
+# of the wheel, under "data/share/static".
+# See https://packaging.python.org/en/latest/specifications/binary-distribution-format/#the-data-directory
"static" = "share/static"
```