.. Copyright (c) 2022-2023, Manuel Schrauth, Florian Goth

.. raw:: html

   <style>
   .rst-content .section>img {
       width: 40px;
       margin-bottom: 0;
       margin-top: 0;
       margin-right: 10px;
       margin-left: 10px;
       float: left;
   }
   </style>

The hypertiling documentation
=============================

Welcome to the official documentation of the hypertiling package! This page is under construction and therefore may not contain the entire functionality of the package yet.


.. toctree::
   :maxdepth: 1
   :caption: Get Hypertiling

   installation
   source
   changelog


.. toctree::
   :maxdepth: 2
   :caption: Examples

   examples/quickstart.ipynb
   examples/edge-reflections.ipynb
   examples/dynamic-manipulation.ipynb
   examples/refinements.ipynb
   examples/geodesics.ipynb
   examples/animations.ipynb
   examples/logo.ipynb
   examples/operators.ipynb

.. toctree::
   :maxdepth: 2
   :caption: Kernels

   examples/srg-kernel.ipynb
   examples/gr-kernel.ipynb
   examples/graph-kernels.ipynb

.. toctree::
   :maxdepth: 1
   :caption: Modules


   core
   kernels
   abc
   hyperpolygon
   transformations
   geodesics
   neighbours
   misc


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

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