Skip to content

Commit

Permalink
doc: flatten folder hierarchy; use 'api' as name
Browse files Browse the repository at this point in the history
  • Loading branch information
@MuellerSeb
MuellerSeb committed Dec 9, 2022
1 parent 7bd2e19 commit 1aaa874
Show file tree
Hide file tree
Showing 15 changed files with 29 additions and 28 deletions.
2 changes: 1 addition & 1 deletion .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ src/gstools/_version.py

# generated docs
docs/source/examples/
docs/source/generated/
docs/source/api/

# other settings
.vscode/
Expand Down
0 docs/source/package.rst → docs/source/api.rst
View file
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/source/contents.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ Contents

index
tutorials
package
api
changelog
2 changes: 1 addition & 1 deletion src/gstools/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
===========
.. autosummary::
:toctree: generated
:toctree: api
covmodel
field
Expand Down
9 changes: 5 additions & 4 deletions src/gstools/covmodel/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
plot
Expand All @@ -16,7 +16,7 @@
Class to construct user defined covariance models
.. autosummary::
:toctree: generated
:toctree:
CovModel
Expand All @@ -25,7 +25,7 @@
Standard Covariance Models
.. autosummary::
:toctree: generated
:toctree:
Gaussian
Exponential
Expand All @@ -42,9 +42,10 @@
JBessel
Truncated Power Law Covariance Models
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
TPLGaussian
TPLExponential
Expand Down
2 changes: 1 addition & 1 deletion src/gstools/covmodel/plot.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The following classes and functions are provided
.. autosummary::
:toctree: generated
:toctree:
plot_variogram
plot_covariance
Expand Down
6 changes: 3 additions & 3 deletions src/gstools/field/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
generator
upscaling
Expand All @@ -16,7 +16,7 @@
^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
SRF
CondSRF
Expand All @@ -25,7 +25,7 @@
^^^^^^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
Field
"""
Expand Down
2 changes: 1 addition & 1 deletion src/gstools/field/generator.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The following classes are provided
.. autosummary::
:toctree: generated
:toctree:
Generator
RandMeth
Expand Down
2 changes: 1 addition & 1 deletion src/gstools/field/upscaling.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
The following functions are provided
.. autosummary::
:toctree: generated
:toctree:
var_coarse_graining
var_no_scaling
Expand Down
2 changes: 1 addition & 1 deletion src/gstools/krige/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
^^^^^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
Krige
Simple
Expand Down
6 changes: 3 additions & 3 deletions src/gstools/normalizer/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
^^^^^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
Normalizer
Field-Normalizer
^^^^^^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
LogNormal
BoxCox
Expand All @@ -28,7 +28,7 @@
^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
apply_mean_norm_trend
remove_trend_norm_mean
Expand Down
6 changes: 3 additions & 3 deletions src/gstools/random/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,23 @@
^^^^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
RNG
Seed Generator
^^^^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
MasterRNG
Distribution factory
^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
dist_gen
Expand Down
6 changes: 3 additions & 3 deletions src/gstools/tools/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
^^^^^^
.. autosummary::
:toctree: generated
:toctree:
vtk_export
vtk_export_structured
Expand All @@ -20,7 +20,7 @@
^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
confidence_scaling
inc_gamma
Expand All @@ -35,7 +35,7 @@
^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
rotated_main_axes
set_angles
Expand Down
6 changes: 3 additions & 3 deletions src/gstools/transform/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
apply
Field Transformations
^^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
binary
discrete
Expand All @@ -32,7 +32,7 @@
^^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
array_discrete
array_boxcox
Expand Down
4 changes: 2 additions & 2 deletions src/gstools/variogram/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
^^^^^^^^^^^^^^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
vario_estimate
vario_estimate_axis
Expand All @@ -16,7 +16,7 @@
^^^^^^^
.. autosummary::
:toctree: generated
:toctree:
standard_bins
Expand Down

0 comments on commit 1aaa874

Please sign in to comment.