.. GW Analysis Tools documentation master file, created by
   sphinx-quickstart on Mon Oct 10 03:07:39 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to GW Analysis Tools's documentation!
=============================================

.. toctree::
        :maxdepth: 2

        :caption: Contents:

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

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

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

Table of Contents
^^^^^^^^^^^^^^^^^ 

.. toctree::    
        :maxdepth: 1

        self
        installation/installation
        tutorials/index
        api/index


Note: these docs followed `this tutorial <https://medium.com/practical-coding/c-documentation-with-doxygen-cmake-sphinx-breathe-for-those-of-use-who-are-totally-lost-7d555386fe13>`_