creates the new toctrees to start seeing content

spjuhel · spjuhel · commit efef7610ee58 · 2024-12-04T19:02:07.000+01:00
diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -1 +1,11 @@
+==============
+API Reference
+==============
+
 Could be nice to have an API section homepage
+
+.. toctree::
+   :caption: API Reference
+   :hidden:
+
+   Modules <climada/climada>
diff --git a/doc/development/index.rst b/doc/development/index.rst
@@ -1,7 +1,19 @@
-====================
-Developer guide
-====================
+.. include:: ../misc/CONTRIBUTING.md
+   :parser: commonmark
 
-Landing page of the Development section
+.. toctree::
+   :maxdepth: 1
+   :caption: Developer Guide
+   :hidden:
 
-Introduce the section and links to all Development guides
+   Development with Git <Guide_Git_Development>
+   Guide_CLIMADA_Tutorial
+   Guide_Configuration
+   Guide_Testing
+   Guide_continuous_integration_GitHub_actions
+   Guide_Review
+   Guide_PythonDos-n-Donts
+   Guide_Exception_Logging
+   Performance and Best Practices <Guide_Py_Performance>
+   CLIMADA Coding Conventions <Guide_CLIMADA_conventions>
+   Building the Documentation <../misc/README>
diff --git a/doc/getting-started/index.rst b/doc/getting-started/index.rst
@@ -20,7 +20,7 @@ You are good to go!
 
 .. seealso::
 
-    You don't have conda installed or you are looking for advaced installation instructions ? Look up our `detailed instructions <http://www.python.org>`__  on CLIMADA installation.
+   You don't have conda installed or you are looking for advanced installation instructions? Look up our :doc:`detailed instructions <install>` on CLIMADA installation.
 
 
 .. dropdown:: How does CLIMADA compute impacts ?
@@ -58,3 +58,10 @@ You are good to go!
    :icon: unlock
 
    And some content!
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   install
+   Python Introduction <0_intro_python>
diff --git a/doc/index.rst b/doc/index.rst
@@ -6,22 +6,96 @@ Welcome to CLIMADA!
    :align: center
    :alt: CLIMADA Logo
 
-CLIMADA stands for CLIMate ADAptation and is a probabilistic natural catastrophe impact model, that also calculates averted damage (benefit) thanks to adaptation measures of any kind (from grey to green infrastructure, behavioural, etc.).
+CLIMADA (CLIMate ADAptation) is a free and open-source software framework for
+comprehensive climate risk assessment. Designed by a large scientific community,
+CLIMADA offers a robust and flexible platform to analyse the impacts of natural
+hazards and explore adaptation strategies, and it can be used by researchers,
+policy and decision-makers.
 
-CLIMADA is primarily developed and maintained by the `Weather and Climate Risks Group <https://wcr.ethz.ch/>`_ at `ETH Zürich <https://ethz.ch/en.html>`_.
+CLIMADA is primarily developed and maintained by the `Weather and Climate Risks
+Group <https://wcr.ethz.ch/>`_ at `ETH Zürich <https://ethz.ch/en.html>`_.
 
-If you use CLIMADA for your own scientific work, please reference the appropriate publications according to the :doc:`misc/citation`.
+If you use CLIMADA for your own scientific work, please reference the
+appropriate publications according to the :doc:`misc/citation`.
 
-This is the documentation of the CLIMADA core module which contains all functionalities necessary for performing climate risk analysis and appraisal of adaptation options. Modules for generating different types of hazards and other specialized applications can be found in the `CLIMADA Petals <https://climada-petals.readthedocs.io/en/stable/>`_ module.
+This is the documentation of the CLIMADA core module which contains all
+functionalities necessary for performing climate risk analysis and appraisal of
+adaptation options. Modules for generating different types of hazards and other
+specialized applications can be found in the `CLIMADA Petals
+<https://climada-petals.readthedocs.io/en/stable/>`_ module.
 
-Jump right in:
+.. grid:: 1 2 2 2
+    :gutter: 4
+    :padding: 2 2 0 0
+    :class-container: sd-text-center
 
-* :doc:`README <misc/README>`
-* :doc:`Getting Started <guide/Guide_get_started>`
-* :doc:`Installation <guide/install>`
-* :doc:`Overview <tutorial/1_main_climada>`
-* `GitHub Repository <https://github.com/CLIMADA-project/climada_python>`_
-* :doc:`Module Reference <climada/climada>`
+    .. grid-item-card:: Getting Started
+        :shadow: md
+
+        Getting started with CLIMADA: How to install?
+        What are the basic concepts and functionalities?
+
+        +++
+
+        .. button-ref:: getting-started/index
+            :ref-type: doc
+            :click-parent:
+            :color: secondary
+            :expand:
+
+
+    .. grid-item-card:: User Guide
+        :shadow: md
+
+        Want to go more in depth? Check out the User guide. It contains detailed
+        tutorials on the different concepts, modules and possible usage of CLIMADA.
+
+        +++
+
+        .. button-ref:: user-guide/index
+            :ref-type: doc
+            :click-parent:
+            :color: secondary
+            :expand:
+
+            To the user guide!
+
+
+
+    .. grid-item-card::  Implementation API reference
+        :shadow: md
+
+        The reference guide contains a detailed description of
+        the CLIMADA API. The API reference describes each module, class,
+        methods and functions.
+
+        +++
+
+        .. button-ref:: api/index
+            :ref-type: doc
+            :click-parent:
+            :color: secondary
+            :expand:
+
+            To the reference guide!
+
+    .. grid-item-card::  Developer guide
+        :shadow: md
+
+        Saw a typo in the documentation? Want to improve
+        existing functionalities? Want to extend them?
+        The contributing guidelines will guide you through
+        the process of improving CLIMADA.
+
+        +++
+
+        .. button-ref:: development/index
+            :ref-type: doc
+            :click-parent:
+            :color: secondary
+            :expand:
+
+            To the development guide!
 
 .. ifconfig:: readthedocs
 
@@ -31,6 +105,8 @@ Jump right in:
       Use the drop-down menu on the bottom left to switch versions.
       ``stable`` refers to the most recent release, whereas ``latest`` refers to the latest development version.
 
+**Date**: |today| **Version**: |version|
+
 .. admonition:: Copyright Notice
 
    Copyright (C) 2017 ETH Zurich, CLIMADA contributors listed in :doc:`AUTHORS.md <misc/AUTHORS>`.
@@ -49,13 +125,13 @@ Jump right in:
 
 .. toctree::
    :maxdepth: 1
+   :hidden:
 
    Getting started <getting-started/index>
    User Guide <user-guide/index>
    Development <development/index>
-   API <api/index>
-   Authors <misc/AUTHORS>
+   API Reference <api/index>
+   About <misc/AUTHORS>
    Changelog <misc/CHANGELOG>
-   Contribute <misc/CONTRIBUTING>
    CLIMADA Petals <https://climada-petals.readthedocs.io/en/stable/>
-   Weather and Climate Risks Group <https://wcr.ethz.ch/>
+   WCR Group <https://wcr.ethz.ch/>
diff --git a/doc/user-guide/index.rst b/doc/user-guide/index.rst
@@ -1,7 +1,20 @@
-===================
+====================
 User guide
-===================
+====================
 
-Landing page of User guide
+Landing page of the user guide
 
-Introduce the tutorials and links to them
+.. toctree::
+   :maxdepth: 2
+   :caption: User guides
+   :hidden:
+
+   Overview <1_main_climada>
+   Hazard <hazard>
+   Exposures <exposures>
+   Impact <impact>
+   Uncertainty Quantification <unsequa>
+   climada_engine_Forecast
+   climada_util_calibrate
+   Google Earth Engine <climada_util_earth_engine>
+   climada_util_api_client
