:og:description: Parser for Numpy, Sphinx, or Google-style docstrings in Python. Install with \`pip install docstring-utils\`.

docstring-utils
===============

|build| |version| |downloads| |license| |Discord|

Parser for Numpy, Sphinx, or Google-style docstrings in Python.

Installation
--------------

``pip install -U docstring-utils``

**Requirements:** ``Python 3.7+``

Contents
--------

.. toctree::

   usage
   api


.. |build| image:: https://img.shields.io/github/workflow/status/DenverCoder1/docstring-utils/Python%20application/main
   :target: https://github.com/DenverCoder1/docstring-utils/actions/workflows/python-app.yml
.. |version| image:: https://img.shields.io/pypi/v/docstring-utils
   :target: https://pypi.org/project/docstring-utils/
.. |downloads| image:: https://static.pepy.tech/personalized-badge/docstring-utils?period=total&units=none&left_color=grey&right_color=orange&left_text=downloads
   :target: https://pepy.tech/project/docstring-utils
.. |license| image:: https://img.shields.io/pypi/l/docstring-utils
   :target: https://github.com/DenverCoder1/docstring-utils/blob/main/LICENSE
.. |Discord| image:: https://img.shields.io/discord/819650821314052106?color=5865F2&logo=discord&logoColor=white
   :target: https://discord.gg/fPrdqh3Zfu