Metadata-Version: 2.4
Name: behave-auto-docstring
Version: 0.1.3
Author: Helge
Project-URL: Repository, https://codeberg.org/helge/behave_auto_docstring
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: behave>=1.3.3
Requires-Dist: griffe>=1.15.0

# behave_auto_docstring

Adds a simple docstring to behave step, e.g.

```python
from behave_auto_docstring import when

@when("A function is declared")
def function(context): ...
```

is equivalent to

```python
from behave import when

@when("A function is declared")
def function(context):
    """
    Usage:

    ```gherkin
    When A function is declared
    ```
    """"
```

## Usage with mkdocs

For mkdocstrings to parse the resulting docs, you need to add

```yaml
plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            extensions:
              - behave_auto_docstring.griffe
```

to your `mkdocs.yml` file.
