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.dev34.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | db05dbbd48963121c9631f8fc83cce6a63b251359145a67357469bea838ab11b |
|
MD5 | 19b699a65dc75ca46e42e70eb12fa69a |
|
BLAKE2b-256 | f0542e7a595414a0a8afe1e450c8c5413fd343809dcd37de1b3063a7b84f25a6 |
Close
Hashes for frigate-0.7.0a0.post0.dev34-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b37bcaef884c72a58d2b3221ad158e94a0c9924551eb1f9c3449ae5b1cfde62c |
|
MD5 | 3ab85121f428aee985be403df7ee76ab |
|
BLAKE2b-256 | 297d07b1f9c267e378680bbf8b08fd9eca84b1b0c857564844669af16ab0c77d |