Adds API to docs

SALib · Sep 16, 2015 · a500930 · a500930
1 parent 90af425
commit a500930
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 14 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,18 @@
+=========
+SALib API
+=========
+
+Samplers
+--------
+
+.. automodule:: SALib.sample.fast
+
+.. automodule:: SALib.sample.ff
+
+.. automodule:: SALib.sample.finite_diff
+
+.. automodule:: SALib.sample.latin
+
+.. automodule:: SALib.sample.morris
+
+.. automodule:: SALib.sample.saltelli
diff --git a/docs/basics.rst b/docs/basics.rst
@@ -199,7 +199,3 @@ error will appear in the sensitivity indices.  For example, we observe a
 negative value for the x2-x3 index.  Typically, these computing errors shrink as
 the number of samples increases.
 
-
-
-.. autofunction:: SALib.analyze.fast.analyze
-
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,21 +6,27 @@ Python implementations of commonly used sensitivity analysis methods, including
 Sobol, Morris, and FAST methods. Useful in systems modeling to calculate the
 effects of model inputs or exogenous factors on outputs of interest.
 
+Supported Methods
+-----------------
+* Sobol Sensitivity Analysis
+  ([`Sobol 2001 <http://www.sciencedirect.com/science/article/pii/S0378475400002706>`_], [`Saltelli 2002 <http://www.sciencedirect.com/science/article/pii/S0010465502002801>`_], [`Saltelli et al. 2010 <http://www.sciencedirect.com/science/article/pii/S0010465509003087>`_])
+* Method of Morris, including groups and optimal trajectories
+  ([`Morris 1991 <http://www.tandfonline.com/doi/abs/10.1080/00401706.1991.10484804>`_], [`Campolongo et al. 2007 <http://www.sciencedirect.com/science/article/pii/S1364815206002805>`_])
+* Fourier Amplitude Sensitivity Test (FAST)
+  ([`Cukier et al. 1973 <http://scitation.aip.org/content/aip/journal/jcp/59/8/10.1063/1.1680571>`_], [`Saltelli et al. 1999 <http://amstat.tandfonline.com/doi/abs/10.1080/00401706.1999.10485594>`_])
+* Delta Moment-Independent Measure
+  ([`Borgonovo 2007 <http://www.sciencedirect.com/science/article/pii/S0951832006000883>`_], [`Plischke et al. 2013 <http://www.sciencedirect.com/science/article/pii/S0377221712008995>`_])
+* Derivative-based Global Sensitivity Measure (DGSM)
+  ([`Sobol and Kucherenko 2009 <http://www.sciencedirect.com/science/article/pii/S0378475409000354>`_])
+* Fractional Factorial Sensitivity Analysis
+  ([`Saltelli et al. 2008 <http://www.wiley.com/WileyCDA/WileyTitle/productCd-0470059974.html>`_])
+
 .. toctree::
    :maxdepth: 2
 
    getting-started
    basics
-
-
-Supported Methods
------------------
-* Sobol Sensitivity Analysis ([`Sobol 2001 <http://www.sciencedirect.com/science/article/pii/S0378475400002706>`_], [`Saltelli 2002 <http://www.sciencedirect.com/science/article/pii/S0010465502002801>`_], [`Saltelli et al. 2010 <http://www.sciencedirect.com/science/article/pii/S0010465509003087>`_])
-* Method of Morris, including groups and optimal trajectories ([`Morris 1991 <http://www.tandfonline.com/doi/abs/10.1080/00401706.1991.10484804>`_], [`Campolongo et al. 2007 <http://www.sciencedirect.com/science/article/pii/S1364815206002805>`_])
-* Fourier Amplitude Sensitivity Test (FAST) ([`Cukier et al. 1973 <http://scitation.aip.org/content/aip/journal/jcp/59/8/10.1063/1.1680571>`_], [`Saltelli et al. 1999 <http://amstat.tandfonline.com/doi/abs/10.1080/00401706.1999.10485594>`_])
-* Delta Moment-Independent Measure ([`Borgonovo 2007 <http://www.sciencedirect.com/science/article/pii/S0951832006000883>`_], [`Plischke et al. 2013 <http://www.sciencedirect.com/science/article/pii/S0377221712008995>`_])
-* Derivative-based Global Sensitivity Measure (DGSM) ([`Sobol and Kucherenko 2009 <http://www.sciencedirect.com/science/article/pii/S0378475409000354>`_])
-* Fractional Factorial Sensitivity Analysis ([`Saltelli et al. 2008 <http://www.wiley.com/WileyCDA/WileyTitle/productCd-0470059974.html>`_])
+   api