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.dev38.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4bab077299a6d8037ff8aeef7fcf8f6cf2fe9e9218de792a7490bc024199167e |
|
MD5 | 08dfd295509b8d95f34f94e14a9a7081 |
|
BLAKE2b-256 | 9de6edc1c0915672939beeb481be71b70a2c7fbcfa4ffa5b6bc5d6281d1be1d2 |
Close
Hashes for frigate-0.7.0a0.post0.dev38-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1780543f94b65350c5967c76ccb94043d65093b77e5e157fe8ab0c14912c137c |
|
MD5 | 708764ae4229bd38446e1f26e99a975f |
|
BLAKE2b-256 | e35938a2279655cb144439d3d57dfe99aa3bf7784ed2866a9c48fc7e7e9d930a |