Metadata-Version: 2.1
Name: hatch-docstring-description
Version: 1.0.2
Project-URL: Issues, https://github.com/flying-sheep/hatch-docstring-description/issues
Project-URL: Source, https://github.com/flying-sheep/hatch-docstring-description
Author-email: "Philipp A." <flying-sheep@web.de>
License-Expression: GPL-3.0-or-later
License-File: LICENSE.md
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Hatch
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: hatchling
Description-Content-Type: text/x-rst

hatch-docstring-description
===========================

|PyPI Version| |PyPI Python Version| |Coverage|

Usage
-----

#. Include it as a plugin to your ``pyproject.toml``:

   .. code:: toml

      [build-system]
      requires = ["hatchling", "hatch-docstring-description"]
      build-backend = "hatchling.build"

#. Mark your ``description`` field as ``dynamic``:

   .. code:: toml

      [project]
      dynamic = ["description"]

License
-------

``hatch-docstring-description`` is distributed under the terms of the `GPL 3 (or later)`_ license.


.. |PyPI Version| image:: https://img.shields.io/pypi/v/hatch-docstring-description.svg
   :target: https://pypi.org/project/hatch-docstring-description
.. |PyPI Python Version| image:: https://img.shields.io/pypi/pyversions/hatch-docstring-description.svg
   :target: https://pypi.org/project/hatch-docstring-description
.. |Coverage| image:: https://codecov.io/github/flying-sheep/hatch-docstring-description/branch/main/graph/badge.svg?token=FZCw1cXSTL
   :target: https://codecov.io/github/flying-sheep/hatch-docstring-description

.. _GPL 3 (or later): https://spdx.org/licenses/GPL-3.0-or-later.html
