自动生成helm文档的工具。
项目描述
护卫舰
护卫舰是一个用于自动为您Helm图表生成文档的工具。
功能
- 从您的Chart.yaml和values.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 查看哈希值)
      
    
    
       关闭
    
      
        
    
    
  
frigate-0.7.0.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 6751aa48945b5dc5d6a415a6e02dfa5c6fa67799dffcc377a1cda4e317d231c2 | |
| MD5 | c92be33991300a0d0c9594248fdf653c | |
| BLAKE2b-256 | 8877584bb28ba1e1296a26157d78e76d1407bf1bd3853587248124fe60e233d1 | 
    
       关闭
    
      
        
    
    
  
frigate-0.7.0-py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 0054f717e11f21f19a62883389da759e0f16ef59fa1905fda95d679044472277 | |
| MD5 | f7ea378c261cf130fa9b5c0a8f1bd49f | |
| BLAKE2b-256 | 5b056e78e1621d355ce8375e0caecccba04ef1392f4cc40946da6d6dcf00a5b8 |