.. mat-clustering documentation master file, created by
   sphinx-quickstart on Tue Oct  1 22:13:17 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to mat-clustering's documentation!
==========================================
   
----

.. include:: ../../matclustering/README.md
   :parser: myst_parser.sphinx_

----

Module contents
---------------

.. automodule:: matclustering
   :members:
   :undoc-members:
   :show-inheritance:


.. toctree:: 
   :maxdepth: 7
   :caption: Modules in MAT-clustering:

   Core Classes <matclustering.core>
   Similarity-based <matclustering.methods.similarity>
   CoClustering (Under Development) <matclustering.methods.coclustering>
   Hierarchical (Under Development) <matclustering.methods.hierarchical>
   
.. toctree::
   :maxdepth: 1
   :titlesonly:
   :caption: Framework Documentation:

   MAT-Tools <https://mat-analysis.github.io/mat-tools/>
   
----

.. include:: ../../CHANGELOG.md
   :parser: myst_parser.sphinx_