Frigate is a tool for automatically generating documentation for your Helm charts.
Features:
- Render documentation from your
Chart.yamlandvalues.yamlfiles. - Supports outputting as markdown, reStructuredText and HTML.
- Sphinx extension for including in Python documentation.
$ pip install frigate
$ frigate gen path/to/chart
Chart
==========
Chart description.
...
Into the repository you want to have the pre-commit hook installed, run:
cat <<EOF >> .pre-commit-config.yaml
- repo: https://github.com/rapidsai/frigate
rev: v0.4.0 # pre-commit autoupdate - to keep the version up to date
hooks:
- id: frigate
EOF
You can add extra parameters with :
- repo: https://github.com/rapidsai/frigate
rev: v0.4.0 # pre-commit autoupdate - to keep the version up to date
hooks:
- id: frigate
args:
- --output=README.rst
- --format=rst
- --no-credits
- --no-deps