Skip to content

Commit 55838d9

Browse files
Add badges and classifiers
1 parent 441fa5e commit 55838d9

File tree

2 files changed

+28
-2
lines changed

2 files changed

+28
-2
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# sphinx-helm
22

3+
![PyPI - Version](https://img.shields.io/pypi/v/sphinx-helm)
4+
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sphinx-helm)
5+
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/kr8s-org/sphinx-helm/test.yaml)
6+
![Read the Docs](https://img.shields.io/readthedocs/sphinx-helm)
7+
38
sphinx-helm is a Sphinx plugin for automatically generating documentation for your [Helm charts](https://helm.sh/).
49

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

711
Features:
812

pyproject.toml

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,28 @@
11
[project]
22
name = "sphinx-helm"
3-
description = "Add your description here"
3+
description = "A Sphinx plugin for generating documentation for your Helm charts."
4+
classifiers = [
5+
# How mature is this project? Common values are
6+
# 3 - Alpha
7+
# 4 - Beta
8+
# 5 - Production/Stable
9+
"Development Status :: 4 - Beta",
10+
11+
# Indicate who your project is intended for
12+
"Intended Audience :: Developers",
13+
"Topic :: Software Development :: Build Tools",
14+
15+
# Pick your license as you wish (see also "license" above)
16+
"License :: OSI Approved :: Apache 2.0 License",
17+
18+
# Specify the Python versions you support here.
19+
"Programming Language :: Python :: 3",
20+
"Programming Language :: Python :: 3.8",
21+
"Programming Language :: Python :: 3.9",
22+
"Programming Language :: Python :: 3.10",
23+
"Programming Language :: Python :: 3.11",
24+
"Programming Language :: Python :: 3.12",
25+
]
426
readme = "README.md"
527
requires-python = ">=3.8"
628
dynamic = ["version"]

0 commit comments

Comments
 (0)