docs updates

VForWaTer · May 20, 2021 · 65f5cbf · 65f5cbf
1 parent 766a966
commit 65f5cbf
Show file tree

Hide file tree

Showing 12 changed files with 75 additions and 17 deletions.
diff --git a/doc/auto_examples/auto_examples_jupyter.zip b/doc/auto_examples/auto_examples_jupyter.zip
diff --git a/doc/auto_examples/auto_examples_python.zip b/doc/auto_examples/auto_examples_python.zip
diff --git a/doc/index.rst b/doc/index.rst
@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to HydroBox's documentation!
-====================================
+Welcome to HydroBox
+===================
 
 .. note::
    Major parts of the toolbox are currently re-written. Most interfaces of
@@ -14,15 +14,32 @@ Welcome to HydroBox's documentation!
    this scope, instead of re-implementing functions that are already there.
 
 .. toctree::
+   :hidden:
    :maxdepth: 1
    :caption: Contents:
 
-   toolboxes
+   toolboxes/index
    auto_examples/index
 
-Indices and tables
-==================
+Installation
+============
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+PyPI
+----
+
+Install hydrobox from the Python Pachage Index like:
+
+.. code-block:: bash
+
+   pip install hydrobox
+
+Github
+------
+
+You can install hydrobox from source like:
+
+.. code-block:: bash
+
+   git clone [email protected]:vforwater/hydrobox
+   cd hydrobox
+   pip install -e .
diff --git a/doc/toolboxes.rst b/doc/toolboxes.rst
diff --git a/doc/toolboxes/gen_modules/hydrobox.geostat.ext_drift_kriging.rst b/doc/toolboxes/gen_modules/hydrobox.geostat.ext_drift_kriging.rst
@@ -0,0 +1,6 @@
+hydrobox.geostat.ext\_drift\_kriging
+====================================
+
+.. currentmodule:: hydrobox.geostat
+
+.. autofunction:: ext_drift_kriging
diff --git a/doc/toolboxes/gen_modules/hydrobox.geostat.gridsearch.rst b/doc/toolboxes/gen_modules/hydrobox.geostat.gridsearch.rst
@@ -0,0 +1,6 @@
+hydrobox.geostat.gridsearch
+===========================
+
+.. currentmodule:: hydrobox.geostat
+
+.. autofunction:: gridsearch
diff --git a/doc/toolboxes/gen_modules/hydrobox.geostat.ordinary_kriging.rst b/doc/toolboxes/gen_modules/hydrobox.geostat.ordinary_kriging.rst
@@ -0,0 +1,6 @@
+hydrobox.geostat.ordinary\_kriging
+==================================
+
+.. currentmodule:: hydrobox.geostat
+
+.. autofunction:: ordinary_kriging
diff --git a/doc/toolboxes/gen_modules/hydrobox.geostat.simple_kriging.rst b/doc/toolboxes/gen_modules/hydrobox.geostat.simple_kriging.rst
@@ -0,0 +1,6 @@
+hydrobox.geostat.simple\_kriging
+================================
+
+.. currentmodule:: hydrobox.geostat
+
+.. autofunction:: simple_kriging
diff --git a/doc/toolboxes/gen_modules/hydrobox.geostat.universal_kriging.rst b/doc/toolboxes/gen_modules/hydrobox.geostat.universal_kriging.rst
@@ -0,0 +1,6 @@
+hydrobox.geostat.universal\_kriging
+===================================
+
+.. currentmodule:: hydrobox.geostat
+
+.. autofunction:: universal_kriging
diff --git a/doc/toolboxes/gen_modules/hydrobox.geostat.variogram.rst b/doc/toolboxes/gen_modules/hydrobox.geostat.variogram.rst
@@ -0,0 +1,6 @@
+hydrobox.geostat.variogram
+==========================
+
+.. currentmodule:: hydrobox.geostat
+
+.. autofunction:: variogram
diff --git a/doc/toolboxes/geostat.rst b/doc/toolboxes/geostat.rst
@@ -0,0 +1,5 @@
+=============
+Geostatistics
+=============
+
+.. automodule:: hydrobox.geostat
diff --git a/doc/toolboxes/index.rst b/doc/toolboxes/index.rst
@@ -0,0 +1,9 @@
+==================
+Toolboxes Overview
+==================
+
+.. toctree::
+    :maxdepth: 1
+    :caption: All toolboxes
+
+    geostat