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.dev3.tar.gz
(25.2 kB
view hashes)
Built Distribution
Close
Hashes for frigate-0.6.0a0.post0.dev3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0af3b66853d209df2990934cf7e34805aa464461b57c89dad232037f1679b26a |
|
MD5 | 74d8a574623ded3d47d0e67ba609a754 |
|
BLAKE2b-256 | d5a07464b8fb5ed946a98f3e64f47cdc5773d5f064684d579f4e1035b6c47e0b |
Close
Hashes for frigate-0.6.0a0.post0.dev3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d2b4b16d0f902919fe038fb8d17bb8b1eca803b3895f9ec020bd23713cd05a9 |
|
MD5 | 6a2f971eeb1efd1ccece5440dd958af5 |
|
BLAKE2b-256 | 7af01e4dc45c7a79bd1572e18fde20ec334d298991c98cd61abfcee68848f6dc |