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
frigate-0.5.0a0.post0.dev7.tar.gz
(25.2 kB
view hashes)
Built Distribution
Close
Hashes for frigate-0.5.0a0.post0.dev7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c3b7bac44d42c9e15e7bc425087ff26b19bfebd2a421f8e6274823fcbf373122 |
|
MD5 | 45eaa011b033928f86845a07f190414a |
|
BLAKE2b-256 | 293106b3bfb631301225d6d0b0cc6b6400f158976d2d6a5dc5fcd075df1bba1d |
Close
Hashes for frigate-0.5.0a0.post0.dev7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b8721cb9e2093e40e07095e65ec204468bb6942e243f1f6671db7a8db7fbb78 |
|
MD5 | 5680d3247ddcf6f30756d39299ac1610 |
|
BLAKE2b-256 | 1a614fb6b219564acf9f1eeae71c663253bf282858bdea8a654f144b8c031d81 |