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
repos:
- 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.4.0a0.post0.dev14.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9e24e183a8ea39040bc05b0a666c5751f8a2b0611df18614f5d2474efffa7bd8 |
|
MD5 | 96e1bb4d91c1675a56d11cd783a3514a |
|
BLAKE2b-256 | 6e07bbb3fc8920b4b6f2821798a931242ce4e38937ee971d6a42b21198d650b9 |
Close
Hashes for frigate-0.4.0a0.post0.dev14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6609a0d8272b37c33c2f44c6aee14df07c3dac1c1140394e87636331173eb87f |
|
MD5 | 7cc2927c95317e1c228db4d51a1fc53e |
|
BLAKE2b-256 | 0cc7c29b31a16c131ac7bc6f499bbef726ecb18445de24c4a319b53498e5265d |