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.dev4.tar.gz
(25.2 kB
view hashes)
Built Distribution
Close
Hashes for frigate-0.5.0a0.post0.dev4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 55ca3e3a0ab846365f9ff87f294bcadeeb9e88b3226ca15bd5497950b59d3582 |
|
MD5 | de91c41e13b02de0f6c82ce77ca76561 |
|
BLAKE2b-256 | de7af816755b4b0338927778964edf5d30838579f34785d3a4795d433ed27d46 |
Close
Hashes for frigate-0.5.0a0.post0.dev4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26255578ad1f87b038b609461a910d3225bdadfdf8c59a6ec10543dce9cfd027 |
|
MD5 | 8332432cf7d70f8fba8fe41189e54c90 |
|
BLAKE2b-256 | 2eb403b9e5a957a2123241326d7332230f2605978e8b560c16000df553dc478c |