simplify docs

Author: MuellerSeb

.gitignore

@@ -88,9 +88,10 @@ celerybeat-schedule
 venv/
 ENV/
 
-# Spyder project settings
+# IDE project settings
 .spyderproject
 .spyproject
+.vscode
 
 # Rope project settings
 .ropeproject
@@ -114,7 +115,7 @@ info/
 
 # generated docs
 docs/source/examples/
-docs/source/generated/
+docs/source/api/
 Cmp_UFZ-campaign.cmp
 
 # generated version file

docs/source/_static/custom.css

@@ -0,0 +1,3 @@
+dl.py.property {
+    display: block !important;
+}

docs/source/_templates/autosummary/class.rst

@@ -0,0 +1,13 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :undoc-members:
+   :inherited-members:
+   :show-inheritance:
+
+.. raw:: latex
+
+    \clearpage

docs/source/_templates/autosummary/module.rst

@@ -0,0 +1,9 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ fullname }}
+
+.. automodule:: {{ fullname }}
+
+.. raw:: latex
+
+    \clearpage

docs/source/_templates/layout.html

@@ -4,18 +4,24 @@
     {{ super() }}
     <br />
     <p class="link caption"><span class="link caption-text">welltestpy Links</span></p>
-    <a href="https://github.com/GeoStat-Framework/welltestpy">welltestpy GitHub</a>
-    <a href="https://doi.org/10.5281/zenodo.1229051">welltestpy Zenodo DOI</a>
-    <a href="https://pypi.org/project/welltestpy/">welltestpy PyPI</a>
+    <ul>
+      <Li><a href="https://github.com/GeoStat-Framework/welltestpy">welltestpy GitHub</a></Li>
+      <Li><a href="https://doi.org/10.5281/zenodo.1229051">welltestpy Zenodo DOI</a></Li>
+      <Li><a href="https://pypi.org/project/welltestpy">welltestpy 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://github.com/GeoStat-Examples">GeoStat Examples</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://github.com/GeoStat-Examples">GeoStat Examples</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>
+    <ul>
+      <Li><a href="{{ pathto('genindex') }}">Index</a></Li>
+      <Li><a href="{{ pathto(master_doc) }}">Sitemap</a></Li>
+    </ul>
   {% endblock %}

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

@@ -7,11 +7,3 @@ welltestpy API
 .. raw:: latex
 
     \clearpage
-
-.. toctree::
-   :hidden:
-
-   data.rst
-   estimate.rst
-   process.rst
-   tools.rst

docs/source/conf.py

@@ -1,5 +1,4 @@
 #!/usr/bin/env python3
-# -*- coding: utf-8 -*-
 #
 # welltestpy documentation build configuration file, created by
 # sphinx-quickstart on Fri Jan  5 14:20:43 2018.
@@ -56,7 +55,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",
@@ -80,7 +79,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
@@ -121,7 +123,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.
@@ -153,14 +155,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.
@@ -249,7 +255,6 @@ def setup(app):
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
-    "Python 3.6": ("https://docs.python.org/3.6", None),
     "Python": ("https://docs.python.org/", None),
     "NumPy": ("http://docs.scipy.org/doc/numpy/", None),
     "SciPy": ("http://docs.scipy.org/doc/scipy/reference", None),

docs/source/contents.rst

@@ -4,9 +4,9 @@ Contents
 
 .. toctree::
    :includehidden:
-   :maxdepth: 3
+   :maxdepth: 5
 
    index
    examples/index
-   package
+   api
    changelog