doc fixes

GeoStat-Framework · Aug 10, 2022 · 4ca31ee · 4ca31ee
1 parent 734912c
commit 4ca31ee
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 18 deletions.
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html
@@ -4,17 +4,23 @@
     {{ super() }}
     <br />
     <p class="link caption"><span class="link caption-text">PyKrige Links</span></p>
-    <a href="https://github.com/GeoStat-Framework/PyKrige">PyKrige GitHub</a>
-    <a href="https://doi.org/10.5281/zenodo.3738604">PyKrige Zenodo DOI</a>
-    <a href="https://pypi.org/project/PyKrige/">PyKrige PyPI</a>
+    <ul>
+      <Li><a href="https://github.com/GeoStat-Framework/PyKrige">PyKrige GitHub</a></Li>
+      <Li><a href="https://doi.org/10.5281/zenodo.3738604">PyKrige Zenodo DOI</a></Li>
+      <Li><a href="https://pypi.org/project/PyKrige/">PyKrige PyPI</a></Li>
+    </ul>
     <br />
     <p class="link caption"><span class="link caption-text">GeoStat Framework</span></p>
-    <a href="https://geostat-framework.org">GeoStat Website</a>
-    <a href="https://github.com/GeoStat-Framework">GeoStat Github</a>
-    <a href="https://geostat-framework.readthedocs.io">GeoStat ReadTheDocs</a>
-    <a href="https://pypi.org/user/geostatframework/">GeoStat PyPI</a>
+    <ul>
+      <Li><a href="https://geostat-framework.org">GeoStat Website</a></Li>
+      <Li><a href="https://github.com/GeoStat-Framework">GeoStat Github</a></Li>
+      <Li><a href="https://geostat-framework.readthedocs.io">GeoStat ReadTheDocs</a></Li>
+      <Li><a href="https://pypi.org/user/geostatframework/">GeoStat PyPI</a></Li>
+    </ul>
     <br />
     <br />
-    <a href="genindex.html">Index</a>
-    <a href="contents.html">Sitemap</a>
-  {% endblock %}
+    <ul>
+      <Li><a href="genindex.html">Index</a></Li>
+      <Li><a href="contents.html">Sitemap</a></Li>
+    </ul>
+    {% endblock %}
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -47,17 +47,34 @@
     "sphinx.ext.mathjax",
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
-    "sphinxcontrib.napoleon",
+    "sphinx.ext.napoleon",  # parameters look better than with numpydoc only
+    "numpydoc",
     "sphinx_gallery.gen_gallery",
     "sphinx.ext.linkcode",
     "m2r2",
 ]
 
-
-autosummary_generate = True
-
 autodoc_default_flags = ["members", "inherited-members"]
 
+# autosummaries from source-files
+autosummary_generate = True
+# dont show __init__ docstring
+autoclass_content = "class"
+# sort class members
+autodoc_member_order = "groupwise"
+# autodoc_member_order = 'bysource'
+
+# Notes in boxes
+napoleon_use_admonition_for_notes = True
+# Attributes like parameters
+# napoleon_use_ivar = True
+# 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
+numpydoc_class_members_toctree = False
+# for the covmodels alot of classmembers show up...
+# maybe switch off with:    :no-inherited-members:
+numpydoc_show_inherited_class_members = True
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -54,14 +54,15 @@ dependencies = [
 [project.optional-dependencies]
 doc = [
     "gstools>=1.3,<2",
+    "scipy<1.9",
     "pillow",
     "scikit-learn>=0.19",
     "m2r2>=0.2.8",
     "matplotlib>=3",
-    "numpydoc>=1.1,<2",
-    "sphinx>=3,<4",
-    "sphinx-gallery>=0.8,<1",
-    "sphinx-rtd-theme>=0.5,<1",
+    "numpydoc>=1.1",
+    "sphinx>=4",
+    "sphinx-gallery>=0.8",
+    "sphinx-rtd-theme>=1",
     "sphinxcontrib-napoleon",
 ]
 plot = ["matplotlib>=3,<4"]