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

Uploaded Source

Built Distribution

frigate-0.1.0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: frigate-0.1.0.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.1.0 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.6.5

File hashes

Hashes for frigate-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f89e8931e552dde00b9ba1a2bab5872afd9afce2a67fbee9b7d9399f95847a07
MD5 b23c2e04613cb309bf153d145eb1bcf0
BLAKE2b-256 15460d33752dddfb5ee84a3ee21dce2a2145b664859e1e0c2228ed44b3c3a105

See more details on using hashes here.

File details

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

File metadata

  • Download URL: frigate-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.1.0 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.6.5

File hashes

Hashes for frigate-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 38ff7f8982a18c86f3e73acdf5866d4a26b0161ed7a168b0295cf0c8ca0ed525
MD5 ec4256a5cacf040287c8a110684f1c11
BLAKE2b-256 bdbd04f9c4965b7e166db2f7396df6fd90c5d8f0ec51be28af1430888ed44cdd

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