Skip to content

Commit

Permalink
Add badges and classifiers
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobtomlinson committed Dec 10, 2024
1 parent 441fa5e commit 55838d9
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# sphinx-helm

![PyPI - Version](https://img.shields.io/pypi/v/sphinx-helm)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sphinx-helm)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/kr8s-org/sphinx-helm/test.yaml)
![Read the Docs](https://img.shields.io/readthedocs/sphinx-helm)

sphinx-helm is a Sphinx plugin for automatically generating documentation for your [Helm charts](https://helm.sh/).

<!-- TODO: Add badges for CI, PyPI, etc -->

Features:

Expand Down
24 changes: 23 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,28 @@
[project]
name = "sphinx-helm"
description = "Add your description here"
description = "A Sphinx plugin for generating documentation for your Helm charts."
classifiers = [
# How mature is this project? Common values are
# 3 - Alpha
# 4 - Beta
# 5 - Production/Stable
"Development Status :: 4 - Beta",

# Indicate who your project is intended for
"Intended Audience :: Developers",
"Topic :: Software Development :: Build Tools",

# Pick your license as you wish (see also "license" above)
"License :: OSI Approved :: Apache 2.0 License",

# Specify the Python versions you support here.
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
]
readme = "README.md"
requires-python = ">=3.8"
dynamic = ["version"]
Expand Down

0 comments on commit 55838d9

Please sign in to comment.