Metadata-Version: 2.3
Name: sphinx-helm
Version: 0.1.0
Summary: Add your description here
Requires-Python: >=3.8
Requires-Dist: click
Requires-Dist: docutils
Requires-Dist: jinja2
Requires-Dist: ruamel-yaml
Provides-Extra: docs
Requires-Dist: myst-parser>=3.0.1; extra == 'docs'
Requires-Dist: sphinx; extra == 'docs'
Requires-Dist: sphinx-click; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Description-Content-Type: text/markdown

# sphinx-helm

sphinx-helm is a Sphinx plugin for automatically generating documentation for your [Helm charts](https://helm.sh/).

<!-- TODO: Add badges for CI, PyPI, etc -->

Features:

- Render documentation from your `Chart.yaml` and `values.yaml` files.
- Sphinx extension for including in Python documentation.
- Works with `rst` and `md` documentation source files.

## Installation

```
$ pip install sphinx-helm
```

## Usage

Add the extension to your Sphinx config.

```python
# conf.py

extensions = ['sphinx-helm.ext']
```

Use the directive to generate documentation for your helm chart.

```rst
.. helm:: path/to/your/helm/chart
```
