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.6.0a0.post0.dev2.tar.gz
(25.2 kB
view hashes)
Built Distribution
Close
Hashes for frigate-0.6.0a0.post0.dev2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c697b1d274b433106aa520fa083c7800696121ebec60858a0faa3c805ea47600 |
|
MD5 | 0a2418c9227f800932bed4b6ae17ad29 |
|
BLAKE2b-256 | d209f6e2b2dfa2d882f1e8eca560bf64e9af6d68ce3508397ed4503680a91c2e |
Close
Hashes for frigate-0.6.0a0.post0.dev2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67dbc14ada9298cecb55a62363bc3fe1159654119af9c2d7c4f07712e3688034 |
|
MD5 | f076d515de6eee4b5fc5455b9b99844c |
|
BLAKE2b-256 | 542daba93f56a89cc52bcdeb2a550ca686a9020c2f0efda30fd7b88c6b5e9292 |