.. kerch documentation master file, created by
   sphinx-quickstart on Fri May 20 18:29:55 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

============================
Welcome to the Kerch package
============================

This package is meant for various kernel-based operations. For the moment,
only the kernel module is available, but a lot of models will follow soon.
If you experience any bug, please let me now: this is only a pre-alpha version.

.. include:: install.rst

.. toctree::
   :maxdepth: 2
   :caption: Modules
   :glob:

   kernel/index
   examples


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

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