.. Add the README from the root directory (must be transformed in rst with m2r) .. include:: ../README.rst

.. toctree::
   :hidden:

   getting_started
   user_guide/index
   tutorials/index
   contributing/index

.. image:: https://github.com/fredmontet/ontime/actions/workflows/ci.yml/badge.svg
   :target: https://github.com/fredmontet/ontime/actions/workflows/ci.yml
   :alt: Continuous Integration


.. image:: https://badge.fury.io/py/ontime.svg
   :target: https://badge.fury.io/py/ontime
   :alt: PyPI version

|

**onTime** Documentation
========================

| onTime is an open source library for sensor data analysis and more. It aims at providing
| a comprehensive API for time series analysis, prediction, as well as anomaly detections.
|

.. note::

    This documentation is a **work in progress**. If you have any questions or suggestions, please
    feel free to contact us or open an issue on the GitHub repository.


.. raw:: html

    <div class="container">
        <div class="row">
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                    <h3 class="card-title">Getting started</h3>
                    <div class="card-body flex-fill">
                        <p class="card-text">
                            Start to use onTime to handle your time series.
                            This guide provides you with an installation guide
                            and tutorials to explain the concepts the library.
                        </p>
                        <a href="https://ontime.re/getting_started"
                           class="btn btn-outline-secondary btn-sm"
                           role="button" aria-pressed="true">
                            Go to the Getting Started guide
                        </a>
                    </div>
                </div>
            </div>
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                    <h3 class="card-title">User Guide</h3>
                    <div class="card-body flex-fill">
                        <p class="card-text">
                            The pages in this section provide detailed tutorials
                            so that you can make great use of onTime's
                            workflows. Also, we present some real world
                            scenarios.
                        </p>
                        <a href="https://ontime.re/user_guide"
                           class="btn btn-outline-secondary btn-sm"
                           role="button" aria-pressed="true">
                            Go to the User Guide
                        </a>
                    </div>
                </div>
            </div>
        </div>
        <div class="row mt-4 mb-4">
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                    <h3 class="card-title">API Reference</h3>
                    <div class="card-body flex-fill">
                        <p class="card-text">
                            <i>Coming soon</i>—This reference is the classical developer's
                            documentation. It explains the classes, methods and
                            variables that can be used within onTime. 
                        </p>
                        <!--<a href="https://ontime.re/api_reference"
                           class="btn btn-secondary btn-sm"
                           role="button" aria-pressed="true">
                            Go to the API Reference
                        </a>-->
                    </div>
                </div>
            </div>
            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
                <div class="card text-center intro-card shadow">
                    <h3 class="card-title">Contribution Guide</h3>
                    <div class="card-body flex-fill">
                        <p class="card-text">
                            Finally, if you are a developer and you want to
                            involve yourself in onTime's quest, the following
                            pages contains all the information you need.
                        </p>
                        <a href="https://ontime.re/contributing"
                           class="btn btn-outline-secondary btn-sm"
                           role="button" aria-pressed="true">
                            Go to the Contribution guide
                        </a>
                    </div>
                </div>
            </div>
        </div>
    </div>