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.dev2.tar.gz
(24.3 kB
view hashes)
Built Distribution
Close
Hashes for frigate-0.5.0a0.post0.dev2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa47f0355cdc7e281221ca64170ab8d80981d9c4006f5e62953d0a661349bd7c |
|
MD5 | 18a014e9d0b3b8f3849eb0977a0bcfbf |
|
BLAKE2b-256 | 8e117c7e35c707e1d425adaab737485916d2006f8347e5dbcc3291697998fe18 |
Close
Hashes for frigate-0.5.0a0.post0.dev2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 88650cf9a0537925fd6ad1cec7c73d0412f79ad04771683c5328bcbeffc72bfb |
|
MD5 | b842a38d3efb75e1f372b88360f830bc |
|
BLAKE2b-256 | a74a0c68a220de24d0939dac3dbcfed2762f56dba69173712679a077939e638a |