Merge pull request #271 from GeoStat-Framework/minor_doc_fixes

Minor doc fixes
GeoStat-Framework · Nov 3, 2022 · 7938ba6 · 7938ba6
2 parents 1ce039b + b09664b
commit 7938ba6
Show file tree

Hide file tree

Showing 24 changed files with 41 additions and 129 deletions.
diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css
@@ -0,0 +1,3 @@
+dl.py.property {
+    display: block !important;
+}
diff --git a/docs/source/_templates/autosummary/module.rst b/docs/source/_templates/autosummary/module.rst
@@ -0,0 +1,9 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ fullname }}
+
+.. automodule:: {{ fullname }}
+
+.. raw:: latex
+
+    \clearpage
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html
@@ -21,7 +21,7 @@
     <br />
     <br />
     <ul>
-      <Li><a href="genindex.html">Index</a></Li>
-      <Li><a href="contents.html">Sitemap</a></Li>
+      <Li><a href="{{ pathto('genindex') }}">Index</a></Li>
+      <Li><a href="{{ pathto(master_doc) }}">Sitemap</a></Li>
     </ul>
     {% endblock %}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -83,7 +83,10 @@ def setup(app):
 # Notes in boxes
 napoleon_use_admonition_for_notes = True
 # Attributes like parameters
-# napoleon_use_ivar = True
+napoleon_use_ivar = True
+# keep "Other Parameters" section
+# https://github.com/sphinx-doc/sphinx/issues/10330
+napoleon_use_param = False
 # this is a nice class-doc layout
 numpydoc_show_class_members = True
 # class members have no separate file, so they are not in a toctree
@@ -125,7 +128,7 @@ def setup(app):
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -157,14 +160,18 @@ def setup(app):
     # Toc options
     "collapse_navigation": False,
     "sticky_navigation": True,
-    "navigation_depth": 4,
+    "navigation_depth": 6,
     "includehidden": True,
     "titles_only": False,
 }
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
+html_static_path = ["_static"]
+
+# These paths are either relative to html_static_path
+# or fully qualified paths (eg. https://...)
+html_css_files = ["custom.css"]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

diff --git a/docs/source/covmodel.plot.rst b/docs/source/covmodel.plot.rst
diff --git a/docs/source/covmodel.rst b/docs/source/covmodel.rst
diff --git a/docs/source/field.generator.rst b/docs/source/field.generator.rst
diff --git a/docs/source/field.rst b/docs/source/field.rst
diff --git a/docs/source/field.upscaling.rst b/docs/source/field.upscaling.rst
diff --git a/docs/source/krige.rst b/docs/source/krige.rst
diff --git a/docs/source/normalizer.rst b/docs/source/normalizer.rst
diff --git a/docs/source/package.rst b/docs/source/package.rst
@@ -7,15 +7,3 @@ GSTools API
 .. raw:: latex
 
     \clearpage
-
-.. toctree::
-   :hidden:
-
-   covmodel.rst
-   field.rst
-   variogram.rst
-   krige.rst
-   random.rst
-   tools.rst
-   transform.rst
-   normalizer.rst
diff --git a/docs/source/random.rst b/docs/source/random.rst
diff --git a/docs/source/tools.rst b/docs/source/tools.rst
diff --git a/docs/source/transform.rst b/docs/source/transform.rst
diff --git a/docs/source/variogram.rst b/docs/source/variogram.rst
diff --git a/src/gstools/__init__.py b/src/gstools/__init__.py
@@ -14,6 +14,8 @@
 ===========
 
 .. autosummary::
+   :toctree: generated
+
     covmodel
     field
     variogram
@@ -123,7 +125,6 @@
 
 .. autosummary::
    EARTH_RADIUS
-
 """
 # Hooray!
 from gstools import (

diff --git a/src/gstools/covmodel/__init__.py b/src/gstools/covmodel/__init__.py
@@ -8,7 +8,9 @@
 ^^^^^^^^^^^
 
 .. autosummary::
-    plot
+   :toctree: generated
+
+   plot
 
 Covariance Base-Class
 ^^^^^^^^^^^^^^^^^^^^^

diff --git a/src/gstools/covmodel/base.py b/src/gstools/covmodel/base.py
@@ -310,7 +310,7 @@ def plot(self, func="variogram", **kwargs):  # pragma: no cover
 
         **kwargs
             Keyword arguments forwarded to the plotting function
-            `"plot_" + func` in :any:`gstools.covmodel.plot`.
+            `"plot_" + func` in :py:mod:`gstools.covmodel.plot`.
 
         See Also
         --------

diff --git a/src/gstools/covmodel/plot.py b/src/gstools/covmodel/plot.py
@@ -7,6 +7,8 @@
 The following classes and functions are provided
 
 .. autosummary::
+   :toctree: generated
+
    plot_variogram
    plot_covariance
    plot_correlation

diff --git a/src/gstools/field/__init__.py b/src/gstools/field/__init__.py
@@ -8,6 +8,8 @@
 ^^^^^^^^^^^
 
 .. autosummary::
+   :toctree: generated
+
     generator
     upscaling
 

diff --git a/src/gstools/field/generator.py b/src/gstools/field/generator.py
@@ -7,6 +7,8 @@
 The following classes are provided
 
 .. autosummary::
+   :toctree: generated
+
    Generator
    RandMeth
    IncomprRandMeth

diff --git a/src/gstools/field/upscaling.py b/src/gstools/field/upscaling.py
@@ -7,6 +7,8 @@
 The following functions are provided
 
 .. autosummary::
+   :toctree: generated
+
    var_coarse_graining
    var_no_scaling
 """

diff --git a/src/gstools/tools/__init__.py b/src/gstools/tools/__init__.py
@@ -61,6 +61,8 @@
    EARTH_RADIUS
 
 ----
+
+.. autodata:: EARTH_RADIUS
 """
 
 from gstools.tools.export import (
-Original file line number
+Diff line change
@@ Expand Up / @@ -61,6 +61,8 @@ @@
        EARTH_RADIUS
     ----
+    .. autodata:: EARTH_RADIUS
     """
     from gstools.tools.export import (
@@ Expand Down @@