Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

frigate

Package Overview
Dependencies
Maintainers
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

frigate

A tool for autogenerating helm documentation.

  • 0.7.0
  • PyPI
  • Socket score

Maintainers
2

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

FAQs


Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc