sphinx-helm is a Sphinx plugin for automatically generating documentation for your Helm charts.
Features:
- Render documentation from your
Chart.yamlandvalues.yamlfiles. - Sphinx extension for including in Python documentation.
- Works with
.rstand.mddocumentation source files.
$ pip install sphinx-helm
Add the extension to your Sphinx config.
# conf.py
extensions = ['sphinx_helm.ext']Use the directive to generate documentation for your helm chart.
.. helm:: path/to/your/helm/chart```{helm} path/to/your/helm/chart
```