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.7.0a0.post0.dev32.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | efb543cdfd5c568c87c78a00f7ebc1b9a032fbda16164f2ec0bea59216e45da6 |
|
MD5 | e0c9564c7aa39e09dc5361bdffe9958f |
|
BLAKE2b-256 | eac244f0d73278cfa0b402c6b9887c1c6d29dca2090cc3eece715a47e420e290 |
Close
Hashes for frigate-0.7.0a0.post0.dev32-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ab2dd330989bfa0593d037daa9e9ee6d602587df5bdda1dee312b3defa01c81 |
|
MD5 | a17c2306036be1b4807d9038c077e9c7 |
|
BLAKE2b-256 | bb65d2f263f1e04951837b756dee1ca4e4043690d1338d08fb9f9b803eaa0765 |