.. mole documentation master file, created by
   sphinx-quickstart on Thu Dec  5 01:24:40 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

======================
MOLE Documentation
======================

----------------------------------------------------------
Welcome to MOLE (Mimetic Operators Library Enhanced)
----------------------------------------------------------

MOLE is a comprehensive library for numerical computations focusing on mimetic difference methods.

.. image:: ../../../logo.png
   :align: center
   :width: 200px

--------------------------------------------------
Key Features
--------------------------------------------------

* Mimetic difference operators
* Support for various boundary conditions
* High-performance numerical computations
* Cross-platform compatibility (C++ and MATLAB implementations)
* Extensive example collection

--------------------------------------------------
Contents
--------------------------------------------------

.. toctree::
   :maxdepth: 4
   :caption: Documentation
   
   api/introduction
   api/cpp_api
   api/matlab_api
   api/gettingstarted
   Contributing Guide <api/CONTRIBUTING>
   Code of Conduct <api/CODE_OF_CONDUCT>
   
--------------------------------------------------
Indices and Tables
--------------------------------------------------

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

.. **Doxygen API Documentation**

.. **C++ API**
.. ------------
.. .. doxygenindex:: 
   :project: MoleCpp

.. **MATLAB API**
.. --------------
.. .. toctree::
..    :maxdepth: 1
..    :caption: MATLAB API

..    ../../doc/doxygen/matlab/mole_MATLAB/index.html

--------------------------------------------------
**More Information**
--------------------------------------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`