adding docs/sphinx/index.rst

.gitignore

@@ -74,7 +74,6 @@ docs/sphinx/_autosummary/
 docs/sphinx/_static/*.html
 docs/sphinx/generated/
 docs/sphinx/savefig/
-docs/sphinx/index.rst
 
 # PyBuilder
 target/

docs/sphinx/index.rst

@@ -0,0 +1,102 @@
+.. "TEEHR: Tools for Exploratory Evaluation in Hydrologic Research" documentation master file, created by
+   sphinx-quickstart on Mon Jan 29 10:49:57 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+.. image: ../images/teehr.png
+
+********************
+TEEHR documentation
+********************
+
+TEEHR (pronounced "tier") is a python tool set for loading, storing, processing and visualizing hydrologic data, particularly National Water Model data, for the purpose of exploring and evaluating the datasets to assess their skill and performance.
+
+.. grid:: 1 2 2 2
+    :gutter: 4
+    :padding: 2 2 0 0
+    :class-container: sd-text-center
+
+    .. grid-item-card:: Getting started
+        :img-top: _static/index_getting_started.svg
+        :class-card: intro-card
+        :shadow: md
+
+        New to *TEEHR*? Check out the getting started guides. They contain an
+        introduction to *TEEHR'* main concepts and links to additional tutorials.
+
+        +++
+
+        .. button-ref:: getting_started
+            :ref-type: ref
+            :click-parent:
+            :color: secondary
+            :expand:
+
+            To the getting started guides
+
+    .. grid-item-card::  User guide
+        :img-top: _static/index_user_guide.svg
+        :class-card: intro-card
+        :shadow: md
+
+        The user guide provides in-depth information on the
+        key concepts of pandas with useful background information and explanation.
+
+        +++
+
+        .. button-ref:: user_guide
+            :ref-type: ref
+            :click-parent:
+            :color: secondary
+            :expand:
+
+            To the user guide
+
+    .. grid-item-card::  API reference
+        :img-top: _static/index_api.svg
+        :class-card: intro-card
+        :shadow: md
+
+        The reference guide contains a detailed description of
+        the TEEHR API. The reference describes how the methods work and which parameters can
+        be used. It assumes that you have an understanding of the key concepts.
+
+        +++
+
+        .. button-ref:: autoapi
+            :ref-type: ref
+            :click-parent:
+            :color: secondary
+            :expand:
+
+            To the reference guide
+
+    .. grid-item-card::  Developer guide
+        :img-top: _static/index_contribute.svg
+        :class-card: intro-card
+        :shadow: md
+
+        Saw a typo in the documentation? Want to improve
+        existing functionalities? The contributing guidelines will guide
+        you through the process of improving TEEHR.
+
+        +++
+
+        .. button-ref:: development
+            :ref-type: ref
+            :click-parent:
+            :color: secondary
+            :expand:
+
+            To the development guide
+
+
+.. toctree::
+   :hidden:
+   :titlesonly:
+   :maxdepth: 3
+
+   getting_started/index
+   user_guide/index
+   development/index
+   changelog/index