Skip to content

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

License

Notifications You must be signed in to change notification settings

kr8s-org/sphinx-helm

 
 

Repository files navigation

sphinx-helm

PyPI - Version PyPI - Python Version GitHub Actions Workflow Status Read the Docs PyPI - License EffVer Versioning

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

Usage

Add the extension to your Sphinx config.

# conf.py

extensions = ['sphinx_helm.ext']

Use the directive to generate documentation for your helm chart.

reStructuredText

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

MyST Markdown

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

```

Languages

  • Python 70.4%
  • Jinja 15.9%
  • Mustache 13.7%