跳转到主要内容

自动生成helm文档的工具。

项目描述

护卫舰

护卫舰是一个用于自动为您Helm图表生成文档的工具。

功能

  • 从您的Chart.yamlvalues.yaml文件中渲染文档。
  • 支持输出为markdown、reStructuredText和HTML。
  • Sphinx扩展,可用于Python文档中。

安装

$ pip install frigate

用法

$ frigate gen path/to/chart

Chart
==========

Chart description.

...

pre-commit钩子

在您想要安装pre-commit钩子的仓库中,运行

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

参数

您可以使用

- 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

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分发

frigate-0.7.0.tar.gz (25.2 kB 查看哈希值)

上传时间

构建分发

frigate-0.7.0-py3-none-any.whl (11.3 kB 查看哈希值)

上传时间 Python 3

由以下提供支持