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
```
1 maintainer
Metadata
1 maintainer
Release files for sphinx-helm 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_helm-0.2.1.tar.gz | 65.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_helm-0.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 91.0 kB
Release files / sphinx_helm-0.2.1.tar.gz
| Download URL | sphinx_helm-0.2.1.tar.gz |
|---|---|
| Size | 65.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7d1b64c699d56710499522e1d9b1d8206459b6725b6fc37f933399cbed93ac1c
|
|
BLAKE2b-256 checksum How to use checksums |
5642d5162332f39e9a56ad8ae5d58ee5d93bc4be2dd5507508c0b12ad109bc7e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 16, 2024.
Transparency logRelease files / sphinx_helm-0.2.1-py3-none-any.whl
| Download URL | sphinx_helm-0.2.1-py3-none-any.whl |
|---|---|
| Size | 25.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
96f342aa034a96da1d72bc1ed8d1b7c169b2cc7a83346f1d4ea154f40ad2981f
|
|
BLAKE2b-256 checksum How to use checksums |
77b9ffa041313883899dab20c7e347fbff0245179a4d6aa8e930048daf9466aa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 16, 2024.
Transparency log
