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.5.0a0.tar.gz
(24.2 kB
view details)
Built Distribution
frigate-0.5.0a0-py3-none-any.whl
(11.3 kB
view details)
File details
Details for the file frigate-0.5.0a0.tar.gz.
File metadata
- Download URL: frigate-0.5.0a0.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 | 02088f01b160a42965d3919c451963aa6f3dde3672bc315c03e5d4e2365c44ec |
|
| MD5 | d96644d0371e41a4a08eecfb909ce26b |
|
| BLAKE2b-256 | ca8ad08d97623114d0d32fbc372f24951584db7fbe79cf1a02fd41fc35440cc3 |
File details
Details for the file frigate-0.5.0a0-py3-none-any.whl.
File metadata
- Download URL: frigate-0.5.0a0-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 | f758a0ff73b73b93917080a60d27091e2d9ee7514e647c8c54548010e3fd1b92 |
|
| MD5 | fefa372f57dc8575bae1a01e1120298e |
|
| BLAKE2b-256 | 62fafd75ed7abdcafb90d14a706dc1eb1b6badc4904b5013e620ace383fb12d8 |
