.. ndshapecheck documentation master file, created by
   sphinx-quickstart on Sat Apr 26 11:25:13 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

ndshapecheck documentation
========================

Welcome to the ndshapecheck docs! Shapecheck is a simple library for checking the shape of
multidimensional arrays, for example numpy arrays or torch tensors. See the contributing
page for information about contributing.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   quickstart
   examples
   contributing
   modules