From 55838d9d243cf489ecd43e6ac366bdf804d927a6 Mon Sep 17 00:00:00 2001 From: Jacob Tomlinson Date: Tue, 10 Dec 2024 09:46:38 +0000 Subject: [PATCH] Add badges and classifiers --- README.md | 6 +++++- pyproject.toml | 24 +++++++++++++++++++++++- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index afd72f6..fbf7402 100644 --- a/README.md +++ b/README.md @@ -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/). - Features: diff --git a/pyproject.toml b/pyproject.toml index 0e443ec..407d81c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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"]