diff --git a/.gitignore b/.gitignore index a04623a10..872d3f40b 100644 --- a/.gitignore +++ b/.gitignore @@ -116,7 +116,7 @@ src/gstools/_version.py # generated docs docs/source/examples/ -docs/source/generated/ +docs/source/api/ # other settings .vscode/ diff --git a/docs/source/package.rst b/docs/source/api.rst similarity index 100% rename from docs/source/package.rst rename to docs/source/api.rst diff --git a/docs/source/conf.py b/docs/source/conf.py index e1a99a2a6..eb5e5fae0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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", diff --git a/docs/source/contents.rst b/docs/source/contents.rst index afd0d9bc6..3224356ee 100644 --- a/docs/source/contents.rst +++ b/docs/source/contents.rst @@ -8,5 +8,5 @@ Contents index tutorials - package + api changelog diff --git a/src/gstools/__init__.py b/src/gstools/__init__.py index 6f5a2034b..60dd1e332 100644 --- a/src/gstools/__init__.py +++ b/src/gstools/__init__.py @@ -13,7 +13,7 @@ =========== .. autosummary:: - :toctree: generated + :toctree: api covmodel field diff --git a/src/gstools/covmodel/__init__.py b/src/gstools/covmodel/__init__.py index 0c61d4041..28ab81f21 100644 --- a/src/gstools/covmodel/__init__.py +++ b/src/gstools/covmodel/__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 diff --git a/src/gstools/covmodel/plot.py b/src/gstools/covmodel/plot.py index e6453a8d5..efcc26300 100644 --- a/src/gstools/covmodel/plot.py +++ b/src/gstools/covmodel/plot.py @@ -6,7 +6,7 @@ The following classes and functions are provided .. autosummary:: - :toctree: generated + :toctree: plot_variogram plot_covariance diff --git a/src/gstools/field/__init__.py b/src/gstools/field/__init__.py index 65718bc78..9d835238b 100644 --- a/src/gstools/field/__init__.py +++ b/src/gstools/field/__init__.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 """ diff --git a/src/gstools/field/generator.py b/src/gstools/field/generator.py index 4e1719507..5db7fae9d 100644 --- a/src/gstools/field/generator.py +++ b/src/gstools/field/generator.py @@ -6,7 +6,7 @@ The following classes are provided .. autosummary:: - :toctree: generated + :toctree: Generator RandMeth diff --git a/src/gstools/field/upscaling.py b/src/gstools/field/upscaling.py index ac5f49a93..6dcbaa7bb 100644 --- a/src/gstools/field/upscaling.py +++ b/src/gstools/field/upscaling.py @@ -6,7 +6,7 @@ The following functions are provided .. autosummary:: - :toctree: generated + :toctree: var_coarse_graining var_no_scaling diff --git a/src/gstools/krige/__init__.py b/src/gstools/krige/__init__.py index 9bb17faed..bb3ef6990 100644 --- a/src/gstools/krige/__init__.py +++ b/src/gstools/krige/__init__.py @@ -7,7 +7,7 @@ ^^^^^^^^^^^^^^^ .. autosummary:: - :toctree: generated + :toctree: Krige Simple diff --git a/src/gstools/normalizer/__init__.py b/src/gstools/normalizer/__init__.py index 24933fc71..505a6d67f 100644 --- a/src/gstools/normalizer/__init__.py +++ b/src/gstools/normalizer/__init__.py @@ -7,7 +7,7 @@ ^^^^^^^^^^^^^^^ .. autosummary:: - :toctree: generated + :toctree: Normalizer @@ -15,7 +15,7 @@ ^^^^^^^^^^^^^^^^ .. autosummary:: - :toctree: generated + :toctree: LogNormal BoxCox @@ -28,7 +28,7 @@ ^^^^^^^^^^^^^^^^^^^^ .. autosummary:: - :toctree: generated + :toctree: apply_mean_norm_trend remove_trend_norm_mean diff --git a/src/gstools/random/__init__.py b/src/gstools/random/__init__.py index 20fd9c450..af8f73786 100644 --- a/src/gstools/random/__init__.py +++ b/src/gstools/random/__init__.py @@ -7,7 +7,7 @@ ^^^^^^^^^^^^^^^^^^^^^^^ .. autosummary:: - :toctree: generated + :toctree: RNG @@ -15,7 +15,7 @@ ^^^^^^^^^^^^^^ .. autosummary:: - :toctree: generated + :toctree: MasterRNG @@ -23,7 +23,7 @@ ^^^^^^^^^^^^^^^^^^^^ .. autosummary:: - :toctree: generated + :toctree: dist_gen diff --git a/src/gstools/tools/__init__.py b/src/gstools/tools/__init__.py index 18892557f..bd3295768 100644 --- a/src/gstools/tools/__init__.py +++ b/src/gstools/tools/__init__.py @@ -7,7 +7,7 @@ ^^^^^^ .. autosummary:: - :toctree: generated + :toctree: vtk_export vtk_export_structured @@ -20,7 +20,7 @@ ^^^^^^^^^^^^^^^^^ .. autosummary:: - :toctree: generated + :toctree: confidence_scaling inc_gamma @@ -35,7 +35,7 @@ ^^^^^^^^^ .. autosummary:: - :toctree: generated + :toctree: rotated_main_axes set_angles diff --git a/src/gstools/transform/__init__.py b/src/gstools/transform/__init__.py index 9f9344c1b..b2e6ce4f2 100644 --- a/src/gstools/transform/__init__.py +++ b/src/gstools/transform/__init__.py @@ -7,7 +7,7 @@ ^^^^^^^ .. autosummary:: - :toctree: generated + :toctree: apply @@ -15,7 +15,7 @@ ^^^^^^^^^^^^^^^^^^^^^ .. autosummary:: - :toctree: generated + :toctree: binary discrete @@ -32,7 +32,7 @@ ^^^^^^^^^^^^^^^^^^^^^ .. autosummary:: - :toctree: generated + :toctree: array_discrete array_boxcox diff --git a/src/gstools/variogram/__init__.py b/src/gstools/variogram/__init__.py index 59e10f551..d8a5b238d 100644 --- a/src/gstools/variogram/__init__.py +++ b/src/gstools/variogram/__init__.py @@ -7,7 +7,7 @@ ^^^^^^^^^^^^^^^^^^^^ .. autosummary:: - :toctree: generated + :toctree: vario_estimate vario_estimate_axis @@ -16,7 +16,7 @@ ^^^^^^^ .. autosummary:: - :toctree: generated + :toctree: standard_bins