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.dev4.tar.gz
(25.3 kB
view hashes)
Built Distribution
Close
Hashes for frigate-0.6.0a0.post0.dev4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce8d8d8beaaf373e35c81c5281113fda37e3b3c4bc7fc93e1b96a90164ef0532 |
|
MD5 | 38cfeae6a69d74ed01506ff1ef55473f |
|
BLAKE2b-256 | 6fe7f6157006636b8be0eb59d77ad4d58938790cd4ad01830f8838e004404d02 |
Close
Hashes for frigate-0.6.0a0.post0.dev4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0494c47df4703b8a964cb896d88b80651aba55c8ccc7faccc295fedd0e5458fd |
|
MD5 | 594ca30788a8d23c6d3efde741f26b2f |
|
BLAKE2b-256 | 6ea84d453561e60775626444f7214c3a3df7fdfb08629a2f110a882269337047 |