A Sphinx plugin for generating documentation for your Helm charts.
Project description
sphinx-helm
sphinx-helm is a Sphinx plugin for automatically generating documentation for your Helm charts.
Features:
- Render documentation from your
Chart.yamlandvalues.yamlfiles. - Sphinx extension for including in Python documentation.
- Works with
.rstand.mddocumentation source files.
Installation
$ pip install sphinx-helm
Usage
Add the extension to your Sphinx config.
# conf.py
extensions = ['sphinx_helm.ext']
Use the directive to generate documentation for your helm chart.
reStructuredText
.. helm:: path/to/your/helm/chart
MyST Markdown
```{helm} path/to/your/helm/chart
```
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sphinx_helm-0.2.1.tar.gz.
File metadata
- Download URL: sphinx_helm-0.2.1.tar.gz
- Upload date:
- Size: 65.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7d1b64c699d56710499522e1d9b1d8206459b6725b6fc37f933399cbed93ac1c
|
|
| MD5 |
eafe521c6bfed680e99ce63c9cc46ec7
|
|
| BLAKE2b-256 |
5642d5162332f39e9a56ad8ae5d58ee5d93bc4be2dd5507508c0b12ad109bc7e
|
Provenance
The following attestation bundles were made for sphinx_helm-0.2.1.tar.gz:
Publisher:
release.yaml on kr8s-org/sphinx-helm
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_helm-0.2.1.tar.gz -
Subject digest:
7d1b64c699d56710499522e1d9b1d8206459b6725b6fc37f933399cbed93ac1c - Sigstore transparency entry: 155678902
- Sigstore integration time:
-
Permalink:
kr8s-org/sphinx-helm@699501a9e9ea81daae2c64f0e3ab9343e6e2e71f -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/kr8s-org
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@699501a9e9ea81daae2c64f0e3ab9343e6e2e71f -
Trigger Event:
push
-
Statement type:
File details
Details for the file sphinx_helm-0.2.1-py3-none-any.whl.
File metadata
- Download URL: sphinx_helm-0.2.1-py3-none-any.whl
- Upload date:
- Size: 25.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
96f342aa034a96da1d72bc1ed8d1b7c169b2cc7a83346f1d4ea154f40ad2981f
|
|
| MD5 |
e630d9932bfc94054e50053f71541bcf
|
|
| BLAKE2b-256 |
77b9ffa041313883899dab20c7e347fbff0245179a4d6aa8e930048daf9466aa
|
Provenance
The following attestation bundles were made for sphinx_helm-0.2.1-py3-none-any.whl:
Publisher:
release.yaml on kr8s-org/sphinx-helm
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
sphinx_helm-0.2.1-py3-none-any.whl -
Subject digest:
96f342aa034a96da1d72bc1ed8d1b7c169b2cc7a83346f1d4ea154f40ad2981f - Sigstore transparency entry: 155678909
- Sigstore integration time:
-
Permalink:
kr8s-org/sphinx-helm@699501a9e9ea81daae2c64f0e3ab9343e6e2e71f -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/kr8s-org
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yaml@699501a9e9ea81daae2c64f0e3ab9343e6e2e71f -
Trigger Event:
push
-
Statement type:
