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.7.0a0.post0.dev1.tar.gz
(25.3 kB
view hashes)
Built Distribution
Close
Hashes for frigate-0.7.0a0.post0.dev1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b844357bfde5b1d973c74ecdb893cc8c0782774d75583d1158fd6ef3f358a1d |
|
MD5 | 348ba22107e725a41505523d6739c62a |
|
BLAKE2b-256 | 0f678ab9f5837469864e756c3bde83c5ccd8102c402eca07954b6792123f1528 |
Close
Hashes for frigate-0.7.0a0.post0.dev1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ef38270b822ea0f97db62d3da1620ceda3c0bc7b1cb2c3902aaea0f4bba4bdf0 |
|
MD5 | f6883f7e5e5cda34c56dea3a71b9a30d |
|
BLAKE2b-256 | dc341e241010948b0f1f3bdef66e60ff5b4c8574660d9ea39be1c243f5e73a27 |