Added user reference

jgomezdans · Oct 31, 2018 · 52ac16d · 52ac16d
1 parent 6f5c979
commit 52ac16d
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,6 +13,7 @@ Welcome to gp_emulator's documentation!
    introduction.rst
    quickstart.rst
    emulating_rt_model.rst
+   user_reference.rst
 
 
 Indices and tables

diff --git a/docs/user_reference.rst b/docs/user_reference.rst
@@ -0,0 +1,24 @@
+.. automodule:: sar_pre_processing.sar_pre_processor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+
+User Reference
+=================
+
+The `GaussianProcess` class
+-----------------------------
+
+.. automodule:: gp_emulator.GaussianProcess
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+The `MultivariateEmulator` class
+-----------------------------
+
+.. automodule:: gp_emulator.MultivariateEmulator
+   :members:
+   :undoc-members:
+   :show-inheritance: