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

Project details

Release history Release notifications | RSS feed

0.8.0a0.post0.dev40 pre-release

Oct 18, 2023

0.8.0a0.post0.dev39 pre-release

Apr 28, 2023

0.7.0

Mar 31, 2023

0.7.0a0.post0.dev38 pre-release

Mar 30, 2023

0.7.0a0.post0.dev37 pre-release

Mar 10, 2023

0.7.0a0.post0.dev34 pre-release

Mar 9, 2023

0.7.0a0.post0.dev32 pre-release

Mar 9, 2023

0.7.0a0.post0.dev1 pre-release

Aug 1, 2022

This version

0.7.0a0 pre-release

Jun 30, 2022

0.6.1

Jul 19, 2022

0.6.0

Jun 29, 2022

0.6.0a0.post0.dev4 pre-release

Jun 30, 2022

0.6.0a0.post0.dev3 pre-release

Jun 28, 2022

0.6.0a0.post0.dev2 pre-release

Jun 7, 2022

0.6.0a0 pre-release

Feb 9, 2022

0.5.0

Feb 9, 2022

0.5.0a0.post0.dev8 pre-release

Feb 9, 2022

0.5.0a0.post0.dev7 pre-release

Feb 9, 2022

0.5.0a0.post0.dev4 pre-release

Feb 2, 2022

0.5.0a0.post0.dev3 pre-release

Aug 26, 2021

0.5.0a0.post0.dev2 pre-release

Aug 23, 2021

0.5.0a0 pre-release

Jul 1, 2021

0.4.0

Jul 1, 2021

0.4.0a0.post0.dev14 pre-release

Jun 30, 2021

0.4.0a0 pre-release

Apr 27, 2021

0.3.0

Mar 31, 2021

0.2.0

May 28, 2020

0.1.0

Apr 29, 2020

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.7.0a0.tar.gz (25.2 kB view details)

Uploaded Jun 30, 2022 Source

Built Distribution

frigate-0.7.0a0-py3-none-any.whl (11.4 kB view details)

Uploaded Jun 30, 2022 Python 3

File details

Details for the file frigate-0.7.0a0.tar.gz.

File metadata

Download URL: frigate-0.7.0a0.tar.gz
Upload date: Jun 30, 2022
Size: 25.2 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for frigate-0.7.0a0.tar.gz
Algorithm	Hash digest
SHA256	`8239e88be0df73c9d1a66c70427dee692be43f3bdbcf9443e828fc141f3c07d4`
MD5	`5ffdc14d06dd00f4b923c2db8fd7308c`
BLAKE2b-256	`e0154e54237f27996ec406af61832eabab55e610374572993f65b4a6c36e910f`

See more details on using hashes here.

File details

Details for the file frigate-0.7.0a0-py3-none-any.whl.

File metadata

Download URL: frigate-0.7.0a0-py3-none-any.whl
Upload date: Jun 30, 2022
Size: 11.4 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.1 CPython/3.8.10

File hashes

Hashes for frigate-0.7.0a0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`4c4795230122396645f4606a5c4c314cfb8dc77c494a23f1c1cc201a97c588c6`
MD5	`9a76dd70e7af1262418244ec764a748c`
BLAKE2b-256	`14ca653d1cd3a4169e5b3d4ef814c1aeb2e2f94c16dfaa235decdeb55dbc4fd3`