Sphinx-helm

sphinx-helm is a Sphinx plugin for automatically generating documentation for your Helm charts.

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

Example

Create an example hello-world Helm chart with helm create.

$ helm create hello-world
Creating hello-world

Enable the plugin in your Sphinx conf.py file:

extensions = ['sphinx_helm.ext']

Now you can use the helm directive wherever you wish in your documentation.

Note

Helm Chart paths are relative to the root of your documentation.

reStructuredText

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

MyST Markdown

```{helm} path/to/your/helm/chart

```