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.yamlandvalues.yamlfiles. - 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
repos:
- 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
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.4.0.tar.gz
(24.2 kB
view details)
Built Distribution
frigate-0.4.0-py3-none-any.whl
(11.3 kB
view details)
File details
Details for the file frigate-0.4.0.tar.gz.
File metadata
- Download URL: frigate-0.4.0.tar.gz
- Upload date:
- Size: 24.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.7.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ce5f3ea31c002496c0156db86878e2b06bf4e9ba88c8f0190af574f234ade928 |
|
| MD5 | 49cc2aa500f7c7c109ca544290f85672 |
|
| BLAKE2b-256 | 23431ff80edc8a80274324315120e0a58f639862e836d46bf51d73554c9dbcd0 |
File details
Details for the file frigate-0.4.0-py3-none-any.whl.
File metadata
- Download URL: frigate-0.4.0-py3-none-any.whl
- Upload date:
- Size: 11.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.7.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ac1255d645a11f870311ffc200dde200934b8319d740e83d3d931ecbde170037 |
|
| MD5 | c024043338a5ae4146f60982eba544b3 |
|
| BLAKE2b-256 | d0b56ead28c465fa53f4e97d963c5eb3c8bc2691bf00350844469b8ea4b6e21d |
