From 1b57d017adeccb59e1f2116da93baab0876ff7ee Mon Sep 17 00:00:00 2001 From: Jimisola Laursen Date: Sat, 7 Mar 2026 15:25:40 +0100 Subject: [PATCH 1/5] docs: documentation overhaul - Standardize README.md with consistent badges and structure - Add CONTRIBUTING.md with repo-specific dev setup - Add/update Antora docs structure - Remove per-repo GitHub Pages workflow - Point documentation badge to central site Signed-off-by: jimisola --- .github/workflows/publish_gh_pages.yml | 47 -------------------------- CONTRIBUTING.md | 25 ++++++++++++++ README.md | 47 +++++++++++--------------- docs/antora-playbook.yml | 1 + 4 files changed, 45 insertions(+), 75 deletions(-) delete mode 100644 .github/workflows/publish_gh_pages.yml create mode 100644 CONTRIBUTING.md diff --git a/.github/workflows/publish_gh_pages.yml b/.github/workflows/publish_gh_pages.yml deleted file mode 100644 index 1908f1b..0000000 --- a/.github/workflows/publish_gh_pages.yml +++ /dev/null @@ -1,47 +0,0 @@ -name: Publish to GitHub Pages -on: - workflow_dispatch: - release: - types: [created] - push: - branches: - - main - -concurrency: - group: github-pages - cancel-in-progress: false -# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages -permissions: - contents: read - pages: write - id-token: write -jobs: - publish_gh_pages: - runs-on: ubuntu-latest - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - steps: - - name: Checkout repository - uses: actions/checkout@v6 - - name: Configure Pages - uses: actions/configure-pages@v5 - - name: Install Node.js - uses: actions/setup-node@v6 - with: - node-version: "24" - - name: Install Antora - run: npm i antora - - name: Install Asciidoctor Kroki extension - run: npm i asciidoctor asciidoctor-kroki - - name: Generate Site - run: npx antora docs/antora-playbook.yml - - name: Create site folders - run: mkdir -p docs/build/site - - name: Upload Artifacts - uses: actions/upload-pages-artifact@v4 - with: - path: docs/build/site - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2e2341c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing to reqstool-python-hatch-plugin + +Thank you for your interest in contributing! + +For DCO sign-off, commit conventions, and code review process, see the organization-wide [CONTRIBUTING.md](https://github.com/reqstool/.github/blob/main/CONTRIBUTING.md). + +## Prerequisites + +- Python 3.13+ +- [Hatch](https://hatch.pypa.io/) (`pip install hatch`) + +## Setup + +```bash +git clone https://github.com/reqstool/reqstool-python-hatch-plugin.git +cd reqstool-python-hatch-plugin +hatch env create +``` + +## Build & Test + +```bash +hatch build +hatch run test +``` diff --git a/README.md b/README.md index 41de0f1..bfaa1a6 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,28 @@ - [![Commit Activity](https://img.shields.io/github/commit-activity/m/reqstool/reqstool-python-hatch-plugin?label=commits&style=for-the-badge)](https://github.com/reqstool/reqstool-python-hatch-plugin/pulse) [![GitHub Issues](https://img.shields.io/github/issues/reqstool/reqstool-python-hatch-plugin?style=for-the-badge&logo=github)](https://github.com/reqstool/reqstool-python-hatch-plugin/issues) [![License](https://img.shields.io/github/license/reqstool/reqstool-python-hatch-plugin?style=for-the-badge&logo=opensourceinitiative)](https://opensource.org/license/mit/) [![Build](https://img.shields.io/github/actions/workflow/status/reqstool/reqstool-python-hatch-plugin/build.yml?style=for-the-badge&logo=github)](https://github.com/reqstool/reqstool-python-hatch-plugin/actions/workflows/build.yml) -[![Static Badge](https://img.shields.io/badge/Documentation-blue?style=for-the-badge&link=docs)](https://reqstool.github.io/reqstool-python-hatch-plugin/reqstool-python-hatch-plugin/0.0.2/index.html) - - +[![Documentation](https://img.shields.io/badge/Documentation-blue?style=for-the-badge&link=docs)](https://reqstool.github.io) -## Description +# Reqstool Python Hatch Plugin -This documentation provides information on how to use the Reqstool Hatch Plugin. The plugin is designed to be used with the Hatch build tool and facilitates the integration of the Reqstool Decorators in your project. +Hatch build hook plugin for [reqstool](https://github.com/reqstool/reqstool-client) that collects decorated code and generates `annotations.yml` during `hatch build`. ## Installation -To use the Reqstool Hatch Plugin, follow these steps: - -- Update your project dependencies in the `pyproject.toml` file and -ensure that the Reqstool Decorators' dependency is listed as follows; +Add to your `pyproject.toml`: ```toml -dependencies = ["reqstool-python-decorators=="] +[build-system] +requires = [ + "hatchling", + "reqstool-python-hatch-plugin==", +] ``` -When you declare this in the pyproject.toml file, you are specifying the required versions for the dependency of the Reqstool Decorators. This ensures that the correct version of the dependencies are used when installing and running your project. - - - ## Usage -### Configuration - -The plugin can be configured through the `pyproject.toml` file. Configure plugin in `pyproject.toml`as follows; +Configure the plugin in `pyproject.toml`: ```toml [tool.hatch.build.hooks.reqstool] @@ -40,17 +32,16 @@ dataset_directory = "docs/reqstool" output_directory = "build/reqstool" ``` -And under `requires` in `[build-system]` you need to add the plugin with the version, see example; +The plugin uses [reqstool-python-decorators](https://github.com/reqstool/reqstool-python-decorators) for processing. -```toml -[build-system] -requires = [ - "hatchling", - "reqstool-python-hatch-plugin==", -] -``` +## Documentation + +Full documentation can be found [here](https://reqstool.github.io). + +## Contributing +See the organization-wide [CONTRIBUTING.md](https://github.com/reqstool/.github/blob/main/CONTRIBUTING.md). -It specifies that the reqstool-python-hatch-plugin is a dependency for the build process, and it should be of a specific version. +## License -Further it defines the paths where the plugin should be applied. In this case, it specifies that the plugin should be applied to files in the src and tests directories. +MIT License. diff --git a/docs/antora-playbook.yml b/docs/antora-playbook.yml index 1e37bbd..9fa40c1 100644 --- a/docs/antora-playbook.yml +++ b/docs/antora-playbook.yml @@ -1,4 +1,5 @@ # yaml-language-server: $schema=https://raw.githubusercontent.com/asciidoctor/asciidoctor-intellij-plugin/main/src/main/resources/jsonSchemas/antoraPlaybookSchema.json +# For local development only. Published site: https://reqstool.github.io site: title: Reqstool Hatch Plugin Documentation From 445b456314eff9037661a6f9c90f09b4bd38c1e9 Mon Sep 17 00:00:00 2001 From: Jimisola Laursen Date: Sat, 7 Mar 2026 16:31:35 +0100 Subject: [PATCH 2/5] docs: rewrite Antora docs using unified plugin template - Add description with features, quick start, minimal setup, prerequisites - Add configuration reference with complete example and individual params - Rewrite usage with basic usage, decorator dependency, lifecycle - Simplify license to uniform format - Remove separate installation.adoc (merged into description) - Simplify nav to single Start entry Signed-off-by: jimisola --- docs/modules/ROOT/nav.adoc | 1 - docs/modules/ROOT/pages/configuration.adoc | 70 ++++++++++++++++++++++ docs/modules/ROOT/pages/description.adoc | 52 +++++++++++++++- docs/modules/ROOT/pages/index.adoc | 6 +- docs/modules/ROOT/pages/installation.adoc | 20 ------- docs/modules/ROOT/pages/license.adoc | 2 +- docs/modules/ROOT/pages/usage.adoc | 42 ++++++++++--- 7 files changed, 160 insertions(+), 33 deletions(-) create mode 100644 docs/modules/ROOT/pages/configuration.adoc delete mode 100644 docs/modules/ROOT/pages/installation.adoc diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index ccbcafa..7917907 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -1,2 +1 @@ * xref:index.adoc[Start] -* xref:usage.adoc[Usage] \ No newline at end of file diff --git a/docs/modules/ROOT/pages/configuration.adoc b/docs/modules/ROOT/pages/configuration.adoc new file mode 100644 index 0000000..4d239f3 --- /dev/null +++ b/docs/modules/ROOT/pages/configuration.adoc @@ -0,0 +1,70 @@ +== Configuration + +The plugin is configured in your `pyproject.toml` file under `[tool.hatch.build.hooks.reqstool]`. + +=== Complete Configuration Example + +[source,toml] +---- +[tool.hatch.build.hooks.reqstool] +# Build hook dependency +dependencies = ["reqstool-python-hatch-plugin"] + +# Directories to scan for decorators +# Default: ["src", "tests"] +sources = ["src", "tests"] + +# Test result file pattern(s) +# Default: "build/junit.xml" +test_results = "build/junit.xml" + +# Directory containing requirements.yml and optional files +# Default: "docs/reqstool" +dataset_directory = "docs/reqstool" + +# Output directory for generated annotations +# Default: "build/reqstool" +output_directory = "build/reqstool" +---- + +=== Configuration Parameters + +==== sources + +Directories to scan for `@Requirements` and `@SVCs` decorators. +Defaults to `["src", "tests"]`. + +[source,toml] +---- +sources = ["src", "tests"] +---- + +==== test_results + +Path or pattern for test result files (JUnit XML). +Defaults to `"build/junit.xml"`. + +[source,toml] +---- +test_results = "build/junit.xml" +---- + +==== dataset_directory + +Directory containing `requirements.yml` and optional reqstool files (`software_verification_cases.yml`, `manual_verification_results.yml`). +Defaults to `"docs/reqstool"`. + +[source,toml] +---- +dataset_directory = "docs/reqstool" +---- + +==== output_directory + +Output directory for the generated `annotations.yml`. +Defaults to `"build/reqstool"`. + +[source,toml] +---- +output_directory = "build/reqstool" +---- diff --git a/docs/modules/ROOT/pages/description.adoc b/docs/modules/ROOT/pages/description.adoc index fd0634d..d60bcaa 100644 --- a/docs/modules/ROOT/pages/description.adoc +++ b/docs/modules/ROOT/pages/description.adoc @@ -1,3 +1,53 @@ == Description -This documentation provides information on how to use the Reqstool Python Hatch Plugin. The plugin is designed to be used with the Hatch build tool and facilitates the integration of the Reqstool Python Decorators in your project. +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. + +=== Features + +* *Hatch integration*: Runs automatically as a build hook during `hatch build` +* *Combines annotations*: Collects `@Requirements` and `@SVCs` decorators from source and test code +* *Assembles package data*: Includes requirements, test results, and annotations in the built package +* *Generates config*: Creates a `reqstool_config.yml` with correct paths for the package structure + +=== Quick Start + +==== Add the Plugin + +Add the build hook dependency to your `pyproject.toml`: + +[source,toml] +---- +[tool.hatch.build.hooks.reqstool] +dependencies = ["reqstool-python-hatch-plugin"] +---- + +==== Default Behavior + +The plugin automatically: + +1. Runs during `hatch build` +2. Scans source and test directories for `@Requirements` and `@SVCs` decorators +3. Generates an `annotations.yml` file in `build/reqstool/` +4. Creates a `reqstool_config.yml` with paths for the package structure +5. Includes reqstool data in the built package (sdist/wheel) + +==== Minimal Setup + +[source] +---- +my-project/ +├── pyproject.toml +├── docs/ +│ └── reqstool/ +│ └── requirements.yml (mandatory) +├── src/ +└── tests/ +---- + +Run `hatch build` and the annotations will be generated automatically. + +=== Prerequisites + +* Python 3.10+ +* https://hatch.pypa.io/[Hatch] +* https://github.com/reqstool/reqstool-python-decorators[reqstool-python-decorators] as a project dependency diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index 036ed3f..7fa5a95 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -2,6 +2,8 @@ include::description.adoc[] -include::installation.adoc[] +include::configuration.adoc[] -include::license.adoc[] \ No newline at end of file +include::usage.adoc[] + +include::license.adoc[] diff --git a/docs/modules/ROOT/pages/installation.adoc b/docs/modules/ROOT/pages/installation.adoc deleted file mode 100644 index aebd353..0000000 --- a/docs/modules/ROOT/pages/installation.adoc +++ /dev/null @@ -1,20 +0,0 @@ -== Installation - -To use the Reqstool Python Hatch Plugin, follow these steps: - -- Update your project dependencies in the `pyproject.toml` file and -ensure that the Reqstool Decorators' dependency is listed as follows; -``` -dependencies = ["reqstool-python-decorators == "] -``` - -When you declare this in the pyproject.toml file, you are specifying the required versions for the dependency of the Reqstool Decorators. This ensures that the correct version of the dependencies are used when installing and running your project. - - - - - - - - - diff --git a/docs/modules/ROOT/pages/license.adoc b/docs/modules/ROOT/pages/license.adoc index 51e84f1..0277da8 100644 --- a/docs/modules/ROOT/pages/license.adoc +++ b/docs/modules/ROOT/pages/license.adoc @@ -1,3 +1,3 @@ == License -This project is licensed under the MIT License - see the LICENSE.md file for details. +MIT License. diff --git a/docs/modules/ROOT/pages/usage.adoc b/docs/modules/ROOT/pages/usage.adoc index f693cf2..20079b9 100644 --- a/docs/modules/ROOT/pages/usage.adoc +++ b/docs/modules/ROOT/pages/usage.adoc @@ -1,18 +1,44 @@ == Usage +=== Basic Usage -=== Configuration +Add the build hook to your `pyproject.toml`: -The plugin can be configured through the `pyproject.toml` file. Configure plugin in `pyproject.toml`as follows; - -```toml +[source,toml] +---- [tool.hatch.build.hooks.reqstool] -dependencies = ["reqstool-python-hatch-plugin == "] +dependencies = ["reqstool-python-hatch-plugin"] sources = ["src", "tests"] test_results = "build/junit.xml" dataset_directory = "docs/reqstool" output_directory = "build/reqstool" -``` -It specifies that the reqstool-python-hatch-plugin is a dependency for the build process, and it should be of a specific version. +---- + +=== Decorator Dependency + +To use `@Requirements` and `@SVCs` decorators in your code, add the decorators package as a dependency: + +[source,toml] +---- +[project] +dependencies = ["reqstool-python-decorators"] +---- + +See https://github.com/reqstool/reqstool-python-decorators[reqstool-python-decorators] for decorator usage. + +=== Running the Build + +[source,bash] +---- +hatch build +---- + +=== Default Lifecycle + +The plugin integrates into the Hatch build process: -Further it defines the paths where the plugin should be applied. In this case, it specifies that the plugin should be applied to files in the src and tests directories. \ No newline at end of file +1. `hatch build` is invoked +2. The build hook scans `sources` directories for decorated code +3. An `annotations.yml` is generated in the `output_directory` +4. A `reqstool_config.yml` is created with paths for the package structure +5. Reqstool data is included in the built sdist/wheel package From 8e5dc314e3fbaaab67291d2ab17af8ba719838ef Mon Sep 17 00:00:00 2001 From: Jimisola Laursen Date: Sat, 7 Mar 2026 16:42:15 +0100 Subject: [PATCH 3/5] docs: streamline nav and page structure - Separate nav items instead of single include-based page - Merge description.adoc content into index.adoc - Remove license.adoc, add inline license to index.adoc - Change nav label from Start to Overview Signed-off-by: jimisola --- docs/modules/ROOT/nav.adoc | 4 +- docs/modules/ROOT/pages/description.adoc | 53 ---------------------- docs/modules/ROOT/pages/index.adoc | 56 ++++++++++++++++++++++-- docs/modules/ROOT/pages/license.adoc | 3 -- 4 files changed, 55 insertions(+), 61 deletions(-) delete mode 100644 docs/modules/ROOT/pages/description.adoc delete mode 100644 docs/modules/ROOT/pages/license.adoc diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 7917907..cfb3122 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -1 +1,3 @@ -* xref:index.adoc[Start] +* xref:index.adoc[Overview] +* xref:configuration.adoc[Configuration] +* xref:usage.adoc[Usage] diff --git a/docs/modules/ROOT/pages/description.adoc b/docs/modules/ROOT/pages/description.adoc deleted file mode 100644 index d60bcaa..0000000 --- a/docs/modules/ROOT/pages/description.adoc +++ /dev/null @@ -1,53 +0,0 @@ -== Description - -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. - -=== Features - -* *Hatch integration*: Runs automatically as a build hook during `hatch build` -* *Combines annotations*: Collects `@Requirements` and `@SVCs` decorators from source and test code -* *Assembles package data*: Includes requirements, test results, and annotations in the built package -* *Generates config*: Creates a `reqstool_config.yml` with correct paths for the package structure - -=== Quick Start - -==== Add the Plugin - -Add the build hook dependency to your `pyproject.toml`: - -[source,toml] ----- -[tool.hatch.build.hooks.reqstool] -dependencies = ["reqstool-python-hatch-plugin"] ----- - -==== Default Behavior - -The plugin automatically: - -1. Runs during `hatch build` -2. Scans source and test directories for `@Requirements` and `@SVCs` decorators -3. Generates an `annotations.yml` file in `build/reqstool/` -4. Creates a `reqstool_config.yml` with paths for the package structure -5. Includes reqstool data in the built package (sdist/wheel) - -==== Minimal Setup - -[source] ----- -my-project/ -├── pyproject.toml -├── docs/ -│ └── reqstool/ -│ └── requirements.yml (mandatory) -├── src/ -└── tests/ ----- - -Run `hatch build` and the annotations will be generated automatically. - -=== Prerequisites - -* Python 3.10+ -* https://hatch.pypa.io/[Hatch] -* https://github.com/reqstool/reqstool-python-decorators[reqstool-python-decorators] as a project dependency diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index 7fa5a95..fb99c97 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -1,9 +1,57 @@ = Reqstool Python Hatch Plugin -include::description.adoc[] +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. -include::configuration.adoc[] +=== Features -include::usage.adoc[] +* *Hatch integration*: Runs automatically as a build hook during `hatch build` +* *Combines annotations*: Collects `@Requirements` and `@SVCs` decorators from source and test code +* *Assembles package data*: Includes requirements, test results, and annotations in the built package +* *Generates config*: Creates a `reqstool_config.yml` with correct paths for the package structure -include::license.adoc[] +=== Quick Start + +==== Add the Plugin + +Add the build hook dependency to your `pyproject.toml`: + +[source,toml] +---- +[tool.hatch.build.hooks.reqstool] +dependencies = ["reqstool-python-hatch-plugin"] +---- + +==== Default Behavior + +The plugin automatically: + +1. Runs during `hatch build` +2. Scans source and test directories for `@Requirements` and `@SVCs` decorators +3. Generates an `annotations.yml` file in `build/reqstool/` +4. Creates a `reqstool_config.yml` with paths for the package structure +5. Includes reqstool data in the built package (sdist/wheel) + +==== Minimal Setup + +[source] +---- +my-project/ +├── pyproject.toml +├── docs/ +│ └── reqstool/ +│ └── requirements.yml (mandatory) +├── src/ +└── tests/ +---- + +Run `hatch build` and the annotations will be generated automatically. + +=== Prerequisites + +* Python 3.10+ +* https://hatch.pypa.io/[Hatch] +* https://github.com/reqstool/reqstool-python-decorators[reqstool-python-decorators] as a project dependency + +== License + +MIT License. diff --git a/docs/modules/ROOT/pages/license.adoc b/docs/modules/ROOT/pages/license.adoc deleted file mode 100644 index 0277da8..0000000 --- a/docs/modules/ROOT/pages/license.adoc +++ /dev/null @@ -1,3 +0,0 @@ -== License - -MIT License. From 32a9fe82ecd5d796456382de99b34b8242bad766 Mon Sep 17 00:00:00 2001 From: Jimisola Laursen Date: Sat, 7 Mar 2026 18:41:42 +0100 Subject: [PATCH 4/5] =?UTF-8?q?docs:=20fix=20Python=20prerequisite=203.10?= =?UTF-8?q?=20=E2=86=92=203.13?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: jimisola --- docs/modules/ROOT/pages/index.adoc | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index fb99c97..bd61e1d 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -2,16 +2,16 @@ 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. -=== Features +== Features * *Hatch integration*: Runs automatically as a build hook during `hatch build` * *Combines annotations*: Collects `@Requirements` and `@SVCs` decorators from source and test code * *Assembles package data*: Includes requirements, test results, and annotations in the built package * *Generates config*: Creates a `reqstool_config.yml` with correct paths for the package structure -=== Quick Start +== Quick Start -==== Add the Plugin +== Add the Plugin Add the build hook dependency to your `pyproject.toml`: @@ -21,7 +21,7 @@ Add the build hook dependency to your `pyproject.toml`: dependencies = ["reqstool-python-hatch-plugin"] ---- -==== Default Behavior +== Default Behavior The plugin automatically: @@ -31,7 +31,7 @@ The plugin automatically: 4. Creates a `reqstool_config.yml` with paths for the package structure 5. Includes reqstool data in the built package (sdist/wheel) -==== Minimal Setup +== Minimal Setup [source] ---- @@ -46,9 +46,9 @@ my-project/ Run `hatch build` and the annotations will be generated automatically. -=== Prerequisites +== Prerequisites -* Python 3.10+ +* Python 3.13+ * https://hatch.pypa.io/[Hatch] * https://github.com/reqstool/reqstool-python-decorators[reqstool-python-decorators] as a project dependency From 2cc768f8d035a465505c175acf869329e02a9449 Mon Sep 17 00:00:00 2001 From: Jimisola Laursen Date: Sat, 7 Mar 2026 18:43:12 +0100 Subject: [PATCH 5/5] docs: use lowercase reqstool consistently Signed-off-by: jimisola --- docs/modules/ROOT/pages/index.adoc | 2 +- docs/modules/ROOT/pages/usage.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc index bd61e1d..b074784 100644 --- a/docs/modules/ROOT/pages/index.adoc +++ b/docs/modules/ROOT/pages/index.adoc @@ -1,4 +1,4 @@ -= Reqstool Python Hatch Plugin += reqstool Python Hatch Plugin 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. diff --git a/docs/modules/ROOT/pages/usage.adoc b/docs/modules/ROOT/pages/usage.adoc index 20079b9..7550f75 100644 --- a/docs/modules/ROOT/pages/usage.adoc +++ b/docs/modules/ROOT/pages/usage.adoc @@ -41,4 +41,4 @@ The plugin integrates into the Hatch build process: 2. The build hook scans `sources` directories for decorated code 3. An `annotations.yml` is generated in the `output_directory` 4. A `reqstool_config.yml` is created with paths for the package structure -5. Reqstool data is included in the built sdist/wheel package +5. reqstool data is included in the built sdist/wheel package