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

Uploaded Source

Built Distribution

frigate-0.2.0-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: frigate-0.2.0.tar.gz
  • Upload date:
  • Size: 21.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.2.0.post20200511 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10

File hashes

Hashes for frigate-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0ee4480f8cf6d97aa94fb164666b0e8ee160dbc2e248819b54f51e0423533e81
MD5 132a0c33beae4bc045d90593d9754e61
BLAKE2b-256 bb459a2fc1f9caa2d50d2a0b369836f5d6deaf2cb91c738887cb9aaac817252b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: frigate-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.2.0.post20200511 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.10

File hashes

Hashes for frigate-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 45252da1a0fd1421f4ac6698ca287fc3a74b488535c0b2d864b53b1aa349d6a9
MD5 a8f5c3495f1ad43954a134681cda1c51
BLAKE2b-256 e31f16f85e7c6d3872cb2feec3af3a4ab527a6eb57191fd53bb2602a47278cb0

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