Frigate

Frigate is a tool for automatically generating documentation for your Helm charts.

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 <<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

Metadata

Release files for frigate 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for frigate 0.7.0
File	Size	Uploaded
frigate-0.7.0.tar.gz	25.2 kB	Mar 31, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for frigate 0.7.0
File	Interpreter	ABI	Platform	Reset
frigate-0.7.0-py3-none-any.whl 11.3 kB Mar 31, 2023	Python 3	none	any	Details

Total release size: 36.5 kB

Release files / frigate-0.7.0.tar.gz

Download URL	frigate-0.7.0.tar.gz
Size	25.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`6751aa48945b5dc5d6a415a6e02dfa5c6fa67799dffcc377a1cda4e317d231c2`
BLAKE2b-256 checksum How to use checksums	`8877584bb28ba1e1296a26157d78e76d1407bf1bd3853587248124fe60e233d1`
Upload date	Mar 31, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.11.2`

Release files / frigate-0.7.0-py3-none-any.whl

Download URL	frigate-0.7.0-py3-none-any.whl
Size	11.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`0054f717e11f21f19a62883389da759e0f16ef59fa1905fda95d679044472277`
BLAKE2b-256 checksum How to use checksums	`5b056e78e1621d355ce8375e0caecccba04ef1392f4cc40946da6d6dcf00a5b8`
Upload date	Mar 31, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.11.2`