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.dev8.tar.gz
(25.2 kB
view hashes)
Built Distribution
Close
Hashes for frigate-0.5.0a0.post0.dev8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0a4f9ffbd1ece657eb1c7da741cc0a8c1776181537eada34364f4783b2d544c |
|
MD5 | 121cc5bd6921cf33a517d7c0abf30047 |
|
BLAKE2b-256 | cd7eb0ddc5b86fd1412a7252acd7a71c554addba205e7f8a54f90da6b2490388 |
Close
Hashes for frigate-0.5.0a0.post0.dev8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16d034c4c3d435421674e68394bd59cc74f2b1467f38b832347b87d15566de04 |
|
MD5 | 1e05900dbcd41c1c7374aeb56ec59387 |
|
BLAKE2b-256 | 14951dfbee51c72cf696970a4d02b134f5e8469c177c85b7368d1c97e5fbe8c2 |