https://github.com/rapidsai/frigate
Frigate is a tool for automatically generating documentation for your Helm charts
https://github.com/rapidsai/frigate
hacktoberfest helm-chart helm-charts
Last synced: 6 months ago
JSON representation
Frigate is a tool for automatically generating documentation for your Helm charts
- Host: GitHub
- URL: https://github.com/rapidsai/frigate
- Owner: rapidsai
- License: other
- Archived: true
- Created: 2020-04-28T15:38:36.000Z (over 5 years ago)
- Default Branch: branch-0.8
- Last Pushed: 2024-12-10T11:33:30.000Z (10 months ago)
- Last Synced: 2025-04-15T20:53:06.178Z (6 months ago)
- Topics: hacktoberfest, helm-chart, helm-charts
- Language: Python
- Homepage:
- Size: 137 KB
- Stars: 84
- Watchers: 4
- Forks: 28
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Frigate
> [!IMPORTANT]
> The `frigate` CLI tool has now been archived. The Sphinx extension has been forked to a new home in [kr8s-org/sphinx-helm](https://github.com/kr8s-org/sphinx-helm).
Frigate is a tool for automatically generating documentation for your [Helm charts](https://helm.sh/).
Features:
- Render documentation from your `Chart.yaml` and `values.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 <> .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
```