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.

...

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

Uploaded Source

Built Distribution

frigate-0.4.0a0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: frigate-0.4.0a0.tar.gz
  • Upload date:
  • Size: 22.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.10

File hashes

Hashes for frigate-0.4.0a0.tar.gz
Algorithm Hash digest
SHA256 ff0f6b696119412b1159e714cf291f97fd883634c2f104cb22cc1de47c53f46d
MD5 d38cbf105521c76d40b606a9a34fa51a
BLAKE2b-256 edde83f13509c96e3fc0b12f91431c01ef28fbb45cdff6193dfe6f210047fe70

See more details on using hashes here.

File details

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

File metadata

  • Download URL: frigate-0.4.0a0-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.10

File hashes

Hashes for frigate-0.4.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 d2ec72b8fff5280645892010c6a8206802bcaec774a9ad97cdb780b82825c89a
MD5 ffdb0af10cd9b1958874d29a739b768e
BLAKE2b-256 cda109fdd0804010303e1d01b257732714484c6025ebbab598ceb667688fe810

See more details on using hashes here.

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