First Sphinx documentation

doc/Makefile

+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/make.bat

+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

doc/source/conf.py

+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+import os
+import sys
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "U4Py"
+copyright = "2023, T. Treffeisen, M. Rudolf"
+author = "T. Treffeisen, M. Rudolf"
+release = "0.0.2dev"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ["sphinx.ext.autodoc"]
+# for x in os.walk(r"C:\Users\Michael Rudolf\HESSENBOX-DA\GitRepos\u4py\u4py"):
+#     path = x[0]
+#     if ".git" not in path and "__" not in path and "egg-info" not in path:
+#         sys.path.insert(0, path)
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+language = "en"
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "classic"
+html_static_path = ["_static"]

doc/source/index.rst

+.. U4Py documentation master file, created by
+   sphinx-quickstart on Thu Jun 22 10:08:15 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+U4Py Documentation
+==================
+
+This Python module was created in the framework of the project Umwelt 4.0 financed by the Hessian Agency for Nature Conservation, Environment and Geology. It is split into several submodules:
+
+ - :doc:`analysis <../u4py.analysis>`: Does the data analysis, e.g., inversion or spatial analysis.
+ - :doc:`plotting <../u4py.plotting>`: Pre-made figures and axis objects for specific plots including formatting.
+ - :doc:`utils <../u4py.utils>`: Various utility functions, e.g., file and project management.
+ - :doc:`addons <../u4py.addons>`: Tools to read externally supplied data such as groundwater levels or weather data.
+
+
+.. toctree::
+   :maxdepth: 4
+   :caption: Contents:
+
+.. automodule:: u4py
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Indices and tables
+==================
+
+* :ref:`Overview of module <modindex>`
+* :ref:`Index of all functions <genindex>`
+.. * :ref:`search`

doc/source/modules.rst

+u4py
+====
+
+.. toctree::
+   :maxdepth: 4
+
+   setup
+   u4py

doc/source/setup.rst

+setup module
+============
+
+.. automodule:: setup
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/source/u4py.addons.rst

+u4py.addons package
+===================
+
+Submodules
+----------
+
+u4py.addons.climate module
+--------------------------
+
+.. automodule:: u4py.addons.climate
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+u4py.addons.gas\_storage module
+-------------------------------
+
+.. automodule:: u4py.addons.gas_storage
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+u4py.addons.geology module
+--------------------------
+
+.. automodule:: u4py.addons.geology
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+u4py.addons.groundwater module
+------------------------------
+
+.. automodule:: u4py.addons.groundwater
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+u4py.addons.rivers module
+-------------------------
+
+.. automodule:: u4py.addons.rivers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: u4py.addons
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/source/u4py.analysis.rst

+u4py.analysis package
+=====================
+
+Submodules
+----------
+
+u4py.analysis.inversion module
+------------------------------
+
+.. automodule:: u4py.analysis.inversion
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+u4py.analysis.other module
+--------------------------
+
+.. automodule:: u4py.analysis.other
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+u4py.analysis.processing module
+-------------------------------
+
+.. automodule:: u4py.analysis.processing
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+u4py.analysis.spatial module
+----------------------------
+
+.. automodule:: u4py.analysis.spatial
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: u4py.analysis
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/source/u4py.plotting.rst

+u4py.plotting package
+=====================
+
+Submodules
+----------
+
+u4py.plotting.axes module
+-------------------------
+
+.. automodule:: u4py.plotting.axes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+u4py.plotting.formatting module
+-------------------------------
+
+.. automodule:: u4py.plotting.formatting
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+u4py.plotting.plots module
+--------------------------
+
+.. automodule:: u4py.plotting.plots
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+u4py.plotting.preparation module
+--------------------------------
+
+.. automodule:: u4py.plotting.preparation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: u4py.plotting
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/source/u4py.rst

+u4py package
+============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   u4py.addons
+   u4py.analysis
+   u4py.plotting
+   u4py.utils
+
+Module contents
+---------------
+
+.. automodule:: u4py
+   :members:
+   :undoc-members:
+   :show-inheritance:

doc/source/u4py.utils.rst

+u4py.utils package
+==================
+
+Submodules
+----------
+
+u4py.utils.cmd\_args module
+---------------------------
+
+.. automodule:: u4py.utils.cmd_args
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+u4py.utils.config module
+------------------------
+
+.. automodule:: u4py.utils.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+u4py.utils.convert module
+-------------------------
+
+.. automodule:: u4py.utils.convert
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+u4py.utils.files module
+-----------------------
+
+.. automodule:: u4py.utils.files
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+u4py.utils.projects module
+--------------------------
+
+.. automodule:: u4py.utils.projects
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+u4py.utils.sql module
+---------------------
+
+.. automodule:: u4py.utils.sql
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: u4py.utils
+   :members:
+   :undoc-members:
+   :show-inheritance: