.. Wake-T documentation master file, created by
   sphinx-quickstart on Mon Oct  4 19:07:37 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Wake-T |release| documentation
==============================

.. |tests| image:: https://github.com/AngelFP/Wake-T/actions/workflows/test-package.yml/badge.svg
   :target: https://github.com/AngelFP/Wake-T/actions

.. |PyPI| image:: https://img.shields.io/pypi/v/Wake-T.svg?logo=python&logoColor=white
   :target: https://pypi.org/project/Wake-T/

.. |codacy| image:: https://app.codacy.com/project/badge/Grade/ea4fbbfd03a94996ba72b7060dc4bf4b
   :target: https://app.codacy.com/gh/Wake-T/Wake-T/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade

.. |codacy-cov| image:: https://app.codacy.com/project/badge/Coverage/ea4fbbfd03a94996ba72b7060dc4bf4b
   :target: https://app.codacy.com/gh/Wake-T/Wake-T/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage

.. |license| image:: https://img.shields.io/github/license/AngelFP/Wake-T
   :target: https://github.com/AngelFP/Wake-T/blob/master/LICENSE

|tests| |codacy| |codacy-cov| |PyPI| |license|

.. grid:: 1 2 2 2
    :gutter: 2

    .. grid-item-card:: Getting started
        :text-align: center

        :octicon:`book;3em`

        Get the code up and running.

        +++

        .. button-ref:: getting_started/index
            :expand:
            :color: primary
            :click-parent:

            To the guide

    .. grid-item-card:: Tutorials
        :text-align: center

        :octicon:`mortar-board;3em`
              
        Step-by-step tutorials covering the functionality of Wake-T.

        +++

        .. button-ref:: tutorials/index
            :expand:
            :color: primary
            :click-parent:

            To the tutorials

    .. grid-item-card:: Examples
        :text-align: center

        :octicon:`light-bulb;3em`

        Explore quick examples showcasing how to use the code.

        +++

        .. button-ref:: examples/index
            :expand:
            :color: primary
            :click-parent:

            To the examples

    .. grid-item-card:: API reference
        :text-align: center

        :octicon:`code;3em`
        
        Detailed documentation of the Wake-T API.

        +++

        .. button-ref:: api/index
            :expand:
            :color: primary
            :click-parent:

            To the reference guide


.. toctree::
   :hidden:
   :maxdepth: 4

   getting_started/index
   tutorials/index
   examples/index
   api/index