Skip to main content

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


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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: frigate-0.7.0.tar.gz
  • Upload date:
  • Size: 25.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for frigate-0.7.0.tar.gz
Algorithm Hash digest
SHA256 6751aa48945b5dc5d6a415a6e02dfa5c6fa67799dffcc377a1cda4e317d231c2
MD5 c92be33991300a0d0c9594248fdf653c
BLAKE2b-256 8877584bb28ba1e1296a26157d78e76d1407bf1bd3853587248124fe60e233d1

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: frigate-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 11.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for frigate-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0054f717e11f21f19a62883389da759e0f16ef59fa1905fda95d679044472277
MD5 f7ea378c261cf130fa9b5c0a8f1bd49f
BLAKE2b-256 5b056e78e1621d355ce8375e0caecccba04ef1392f4cc40946da6d6dcf00a5b8

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page