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.dev37.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ceed33df8bf9cb9ef70b6437ff0e60544206301dd05c481d412991522d3c24e9 |
|
MD5 | ccc57c8656ec3564557414baf1c350c5 |
|
BLAKE2b-256 | c425cb6c04bb053adbc334ed30a6e5b958466e837295d553322bfb44720a760d |
Close
Hashes for frigate-0.7.0a0.post0.dev37-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f3bf88a40d336880b5f108e1d388f89daad9ec8d3c74538e2d99294396a44327 |
|
MD5 | bb2e8917797bbce3118aa37a1c3e9e57 |
|
BLAKE2b-256 | 52a70e6fcf75edc7e0db2954be41db26d696cf25d536cd74d8f1ad5393c7718b |