You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/modules/ROOT/pages/index.adoc
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,16 +2,16 @@
2
2
3
3
This Hatch build hook generates annotations and assembles reqstool data during `hatch build`. It collects decorated code using https://github.com/reqstool/reqstool-python-decorators[reqstool-python-decorators] and packages everything for consumption by the reqstool CLI.
4
4
5
-
===Features
5
+
== Features
6
6
7
7
* *Hatch integration*: Runs automatically as a build hook during `hatch build`
8
8
* *Combines annotations*: Collects `@Requirements` and `@SVCs` decorators from source and test code
9
9
* *Assembles package data*: Includes requirements, test results, and annotations in the built package
10
10
* *Generates config*: Creates a `reqstool_config.yml` with correct paths for the package structure
11
11
12
-
=== Quick Start
12
+
== Quick Start
13
13
14
-
==== Add the Plugin
14
+
== Add the Plugin
15
15
16
16
Add the build hook dependency to your `pyproject.toml`:
17
17
@@ -21,7 +21,7 @@ Add the build hook dependency to your `pyproject.toml`:
21
21
dependencies = ["reqstool-python-hatch-plugin"]
22
22
----
23
23
24
-
==== Default Behavior
24
+
== Default Behavior
25
25
26
26
The plugin automatically:
27
27
@@ -31,7 +31,7 @@ The plugin automatically:
31
31
4. Creates a `reqstool_config.yml` with paths for the package structure
32
32
5. Includes reqstool data in the built package (sdist/wheel)
33
33
34
-
==== Minimal Setup
34
+
== Minimal Setup
35
35
36
36
[source]
37
37
----
@@ -46,9 +46,9 @@ my-project/
46
46
47
47
Run `hatch build` and the annotations will be generated automatically.
48
48
49
-
=== Prerequisites
49
+
== Prerequisites
50
50
51
-
* Python 3.10+
51
+
* Python 3.13+
52
52
* https://hatch.pypa.io/[Hatch]
53
53
* https://github.com/reqstool/reqstool-python-decorators[reqstool-python-decorators] as a project dependency
0 commit comments