.. pasteur documentation master file, created by sphinx-quickstart.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Pasteur's documentation!
=============================================
.. image:: https://badge.fury.io/py/pasteur.svg
    :target: https://pypi.org/project/pasteur/
    :alt: PyPI package version

.. image:: https://readthedocs.org/projects/pasteur/badge/?version=latest
    :target: https://docs.pasteur.dev/
    :alt: Docs build status

.. image:: https://img.shields.io/badge/license-Apache%202.0-informational.svg
    :target: https://opensource.org/license/apache2-0-php/
    :alt: License is Apache 2.0

.. image:: https://img.shields.io/badge/python-3.10%2B-informational.svg
    :target: https://pypi.org/project/pasteur/
    :alt: Python version 3.10+

.. image:: https://img.shields.io/badge/code%20style-black-black.svg
    :target: https://github.com/psf/black
    :alt: Code style is Black

----------------------

This documentation is a work-in-progress!


.. toctree::
   :maxdepth: 2
   :caption: Preliminaries
   :glob:

   preliminaries/*

.. toctree::
   :maxdepth: 2
   :caption: Tutorial
   :glob:

   tutorial/*


API documentation
=================

.. autosummary::
   :toctree: api
   :caption: API documentation
   :template: autosummary/pasteur.rst
   :recursive:

   pasteur

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. * :ref:`spec`