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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for frigate-0.3.0.tar.gz
Algorithm Hash digest
SHA256 fac04d242c911573b6fbf530826ece832055d613ef4a26280568f84f8e4f52de
MD5 0e5119080d23bbded2f71d7a5a2d925b
BLAKE2b-256 478b289dd2dbdd0b5d7f807b0f28a6e46e38a8e9031db6b0917b708df88eaa07

See more details on using hashes here.

File details

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

File metadata

  • Download URL: frigate-0.3.0-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/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.10

File hashes

Hashes for frigate-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e6ca59f77636597119945e2e2cab012f9fb27c6994048879b77b53067ab09264
MD5 059144a82ee4c1b9357956bb5679d0f3
BLAKE2b-256 61ee2266e9bc8936504d09ba4306e858f9829ab56ba5f45d2c36743f02c5ef76

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