A tool for autogenerating helm documentation.
Project description
Frigate
Frigate is a tool for automatically generating documentation for your Helm charts.
Features:
- Render documentation from your
Chart.yaml
andvalues.yaml
files. - Supports outputting as markdown, reStructuredText and HTML.
- Sphinx extension for including in Python documentation.
Installation
$ pip install frigate
Usage
$ frigate gen path/to/chart
Chart
==========
Chart description.
...
Pre-commit-hook
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
Parameters
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for frigate-0.8.0a0.post0.dev40.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e59604f5362fc1b1cab93069b3a695422e10d3da6d0e351caef7058ddce89bc |
|
MD5 | 2a75a8e93085ce90669ca2037b04161e |
|
BLAKE2b-256 | 06f9f268e3c125c7202d197683e439f21e0b2b39973059c9f7e4d44884f22590 |
Close
Hashes for frigate-0.8.0a0.post0.dev40-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1a544adeea6ebd8d906977e5ba51147da1d66c18b192b5ee052e757d6310e23 |
|
MD5 | 8d601e26f11d49ba4f53e9facf15d16a |
|
BLAKE2b-256 | dbc9cbb83e790fea4ccb5c9aa37c293b08101eb65c07c2f794f3917884781518 |