Metadata-Version: 2.1
Name: scanpydoc
Version: 0.8
Summary: A series of Sphinx extensions to get maintainable numpydoc style documentation.
Project-URL: Source, https://github.com/theislab/scanpydoc/
Project-URL: Documentation, https://icb-scanpydoc.readthedocs-hosted.com/
Author-email: Philipp Angerer <phil.angerer@gmail.com>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8.1
Requires-Dist: sphinx>=3.0
Provides-Extra: dev
Requires-Dist: pre-commit; extra == 'dev'
Provides-Extra: doc
Requires-Dist: scanpydoc[theme,typehints]; extra == 'doc'
Requires-Dist: sphinx; extra == 'doc'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Provides-Extra: theme
Requires-Dist: sphinx-book-theme>=1.0.1; extra == 'theme'
Provides-Extra: typehints
Requires-Dist: sphinx-autodoc-typehints>=1.15.2; extra == 'typehints'
Description-Content-Type: text/x-rst

scanpydoc |pypi| |docs| |tests| |checks| |cov|
==============================================

A collection of Sphinx extensions similar to (but more flexible than) numpydoc.

Check the self-documenting documentation at https://icb-scanpydoc.readthedocs-hosted.com

.. |pypi| image:: https://img.shields.io/pypi/v/scanpydoc.svg
   :target: https://pypi.org/project/scanpydoc/
   :alt: PiPI version
.. |docs| image:: https://readthedocs.com/projects/icb-scanpydoc/badge/
   :target: https://icb-scanpydoc.readthedocs-hosted.com/
   :alt: doc build status
.. |tests| image:: https://github.com/theislab/scanpydoc/actions/workflows/ci.yml/badge.svg
   :target: https://github.com/theislab/scanpydoc/actions/workflows/ci.yml
   :alt: python test status
.. |checks| image:: https://results.pre-commit.ci/badge/github/theislab/scanpydoc/main.svg
   :target: https://results.pre-commit.ci/latest/github/theislab/scanpydoc/main
   :alt: pre-commit.ci status
.. |cov| image:: https://codecov.io/gh/theislab/scanpydoc/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/theislab/scanpydoc
   :alt: coverage
