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.5.0a0.post0.dev3.tar.gz
(24.3 kB
view hashes)
Built Distribution
Close
Hashes for frigate-0.5.0a0.post0.dev3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7944d04825da83b21e5f7abb463bf20780c8235a7251d94ae981a7b28e43e57b |
|
MD5 | fc8a44f11d5cd5ec447e7a7df089f019 |
|
BLAKE2b-256 | 91d4a4050f382cba68d3f98fb2cbf01dbfa18dfb7d51325e9410d31dc8bfad50 |
Close
Hashes for frigate-0.5.0a0.post0.dev3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 88576cf320ad5d307c27c9c2c913b7407ac42dfbe0e9ece8220407ad3304aaa0 |
|
MD5 | c90b3706138bf3a9aad685f4932606bf |
|
BLAKE2b-256 | fab0be9807cc879cdba0ae8c53d439f74c92849baac74655f4cb62f45c44a281 |