Merge pull request #290 from GeoStat-Framework/doc_math_and_nesting_fix

Doc math and nesting fix

Author: MuellerSeb

.gitignore

@@ -116,7 +116,7 @@ src/gstools/_version.py
 
 # generated docs
 docs/source/examples/
-docs/source/generated/
+docs/source/api/
 
 # other settings
 .vscode/

docs/source/package.rst renamed to docs/source/api.rst

@@ -60,7 +60,7 @@ def setup(app):
     "sphinx.ext.doctest",
     "sphinx.ext.intersphinx",
     "sphinx.ext.coverage",
-    "sphinx.ext.imgmath",
+    "sphinx.ext.mathjax",
     "sphinx.ext.ifconfig",
     "sphinx.ext.viewcode",
     "sphinx.ext.autosummary",

docs/source/conf.py

@@ -8,5 +8,5 @@ Contents
 
    index
    tutorials
-   package
+   api
    changelog

docs/source/contents.rst

@@ -13,7 +13,7 @@
 ===========
 
 .. autosummary::
-   :toctree: generated
+   :toctree: api
 
     covmodel
     field

src/gstools/__init__.py

@@ -7,7 +7,7 @@
 ^^^^^^^^^^^
 
 .. autosummary::
-   :toctree: generated
+   :toctree:
 
    plot
 
@@ -16,7 +16,7 @@
 Class to construct user defined covariance models
 
 .. autosummary::
-   :toctree: generated
+   :toctree:
 
    CovModel
 
@@ -25,7 +25,7 @@
 Standard Covariance Models
 
 .. autosummary::
-   :toctree: generated
+   :toctree:
 
    Gaussian
    Exponential
@@ -42,9 +42,10 @@
    JBessel
 
 Truncated Power Law Covariance Models
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. autosummary::
-   :toctree: generated
+   :toctree:
 
    TPLGaussian
    TPLExponential

src/gstools/covmodel/__init__.py

@@ -6,7 +6,7 @@
 The following classes and functions are provided
 
 .. autosummary::
-   :toctree: generated
+   :toctree:
 
    plot_variogram
    plot_covariance

src/gstools/covmodel/plot.py

@@ -7,7 +7,7 @@
 ^^^^^^^^^^^
 
 .. autosummary::
-   :toctree: generated
+   :toctree:
 
     generator
     upscaling
@@ -16,7 +16,7 @@
 ^^^^^^^^^^^^^^^^^^^^
 
 .. autosummary::
-   :toctree: generated
+   :toctree:
 
    SRF
    CondSRF
@@ -25,7 +25,7 @@
 ^^^^^^^^^^^^^^^^
 
 .. autosummary::
-   :toctree: generated
+   :toctree:
 
    Field
 """

src/gstools/field/__init__.py

@@ -6,7 +6,7 @@
 The following classes are provided
 
 .. autosummary::
-   :toctree: generated
+   :toctree:
 
    Generator
    RandMeth

src/gstools/field/generator.py

@@ -6,7 +6,7 @@
 The following functions are provided
 
 .. autosummary::
-   :toctree: generated
+   :toctree:
 
    var_coarse_graining
    var_no_scaling