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.8.0a0.post0.dev39.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 995a965c27b6099b2a0e67f01dc5a320bd2be71f76b43fedadacae74ddf109e3 |
|
MD5 | 88af24631ceec584ade2bd7ad1cf6cd9 |
|
BLAKE2b-256 | 0f3746e427645fa1eb0fd01c78073d03a825df8cbe5a81e75767bb43be6f5249 |
Close
Hashes for frigate-0.8.0a0.post0.dev39-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | af77e32d91e22b3f35046e8d7fee73c0771c6c5a580ac222f81b4d36ceb58ee2 |
|
MD5 | e723f23471e7d16e5d6f2e1ab4c6e960 |
|
BLAKE2b-256 | 1b83e4196341af6f7c8a5739d12631f6b366bcbe633e4983c86ff5b92a0452d9 |