doc update

IndEcol · Jan 19, 2024 · 9992ffb · 9992ffb
1 parent 4f03a40
commit 9992ffb
Show file tree

Hide file tree

Showing 24 changed files with 1,804 additions and 51 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -33,6 +33,10 @@ Depracted
   The method get_row_data() is deprecated and will be removed in v0.6.0. 
   Use extension.extract() instead.
 
+Misceallaneous
+==============
+
+* Updated and restructuring of the documentation
 
 ***************************
 v0.5.2 - 20230815

diff --git a/doc/source/api_doc/pymrio.Extension.contains.rst b/doc/source/api_doc/pymrio.Extension.contains.rst
@@ -0,0 +1,6 @@
+pymrio.Extension.contains
+=========================
+
+.. currentmodule:: pymrio
+
+.. automethod:: Extension.contains
diff --git a/doc/source/api_doc/pymrio.Extension.fullmatch.rst b/doc/source/api_doc/pymrio.Extension.fullmatch.rst
@@ -0,0 +1,6 @@
+pymrio.Extension.fullmatch
+==========================
+
+.. currentmodule:: pymrio
+
+.. automethod:: Extension.fullmatch
diff --git a/doc/source/api_doc/pymrio.Extension.match.rst b/doc/source/api_doc/pymrio.Extension.match.rst
@@ -0,0 +1,6 @@
+pymrio.Extension.match
+======================
+
+.. currentmodule:: pymrio
+
+.. automethod:: Extension.match
diff --git a/doc/source/api_doc/pymrio.IOSystem.contains.rst b/doc/source/api_doc/pymrio.IOSystem.contains.rst
@@ -0,0 +1,6 @@
+pymrio.IOSystem.contains
+========================
+
+.. currentmodule:: pymrio
+
+.. automethod:: IOSystem.contains
diff --git a/doc/source/api_doc/pymrio.IOSystem.extension_contains.rst b/doc/source/api_doc/pymrio.IOSystem.extension_contains.rst
@@ -0,0 +1,6 @@
+pymrio.IOSystem.extension\_contains
+===================================
+
+.. currentmodule:: pymrio
+
+.. automethod:: IOSystem.extension_contains
diff --git a/doc/source/api_doc/pymrio.IOSystem.extension_fullmatch.rst b/doc/source/api_doc/pymrio.IOSystem.extension_fullmatch.rst
@@ -0,0 +1,6 @@
+pymrio.IOSystem.extension\_fullmatch
+====================================
+
+.. currentmodule:: pymrio
+
+.. automethod:: IOSystem.extension_fullmatch
diff --git a/doc/source/api_doc/pymrio.IOSystem.extension_match.rst b/doc/source/api_doc/pymrio.IOSystem.extension_match.rst
@@ -0,0 +1,6 @@
+pymrio.IOSystem.extension\_match
+================================
+
+.. currentmodule:: pymrio
+
+.. automethod:: IOSystem.extension_match
diff --git a/doc/source/api_doc/pymrio.IOSystem.find.rst b/doc/source/api_doc/pymrio.IOSystem.find.rst
@@ -0,0 +1,6 @@
+pymrio.IOSystem.find
+====================
+
+.. currentmodule:: pymrio
+
+.. automethod:: IOSystem.find
diff --git a/doc/source/api_doc/pymrio.IOSystem.fullmatch.rst b/doc/source/api_doc/pymrio.IOSystem.fullmatch.rst
@@ -0,0 +1,6 @@
+pymrio.IOSystem.fullmatch
+=========================
+
+.. currentmodule:: pymrio
+
+.. automethod:: IOSystem.fullmatch
diff --git a/doc/source/api_doc/pymrio.IOSystem.match.rst b/doc/source/api_doc/pymrio.IOSystem.match.rst
@@ -0,0 +1,6 @@
+pymrio.IOSystem.match
+=====================
+
+.. currentmodule:: pymrio
+
+.. automethod:: IOSystem.match
diff --git a/doc/source/api_doc/pymrio.build_agg_matrix.rst b/doc/source/api_doc/pymrio.build_agg_matrix.rst
@@ -0,0 +1,6 @@
+pymrio.build\_agg\_matrix
+=========================
+
+.. currentmodule:: pymrio
+
+.. autofunction:: build_agg_matrix
diff --git a/doc/source/api_doc/pymrio.convert_to_long.rst b/doc/source/api_doc/pymrio.convert_to_long.rst
@@ -0,0 +1,6 @@
+pymrio.convert\_to\_long
+========================
+
+.. currentmodule:: pymrio
+
+.. autofunction:: convert_to_long
diff --git a/doc/source/api_doc/pymrio.index_contains.rst b/doc/source/api_doc/pymrio.index_contains.rst
@@ -0,0 +1,6 @@
+pymrio.index\_contains
+======================
+
+.. currentmodule:: pymrio
+
+.. autofunction:: index_contains
diff --git a/doc/source/api_doc/pymrio.index_fullmatch.rst b/doc/source/api_doc/pymrio.index_fullmatch.rst
@@ -0,0 +1,6 @@
+pymrio.index\_fullmatch
+=======================
+
+.. currentmodule:: pymrio
+
+.. autofunction:: index_fullmatch
diff --git a/doc/source/api_doc/pymrio.index_match.rst b/doc/source/api_doc/pymrio.index_match.rst
@@ -0,0 +1,6 @@
+pymrio.index\_match
+===================
+
+.. currentmodule:: pymrio
+
+.. autofunction:: index_match
diff --git a/doc/source/api_references.rst b/doc/source/api_references.rst
@@ -19,6 +19,7 @@ Test system
 
     load_test
 
+
 Download MRIO databases
 ===========================
 
@@ -108,9 +109,12 @@ for one specified row.
 
    Extension.get_row_data
 
-***********************
-Exploring the IO System
-***********************
+********************
+Exploring and Search
+********************
+
+Structure
+==========
 
 The following functions provide informations about the structure of
 the IO System and the extensions. The methods work on the IOSystem as well as
@@ -129,6 +133,24 @@ directly on the Extensions.
    Extension.get_rows
 
 
+Finding accounts
+================
+
+.. autosummary::
+   :toctree: api_doc/
+
+   IOSystem.find
+   IOSystem.contains
+   IOSystem.match
+   IOSystem.fullmatch
+   Extension.contains
+   Extension.match
+   Extension.fullmatch
+   IOSystem.extension_contains
+   IOSystem.extension_fullmatch
+   IOSystem.extension_match
+   index_contains
+
 
 ************
 Calculations
@@ -270,6 +292,23 @@ Visualization
 
    Extension.plot_account
 
+*******
+Utility
+*******
+
+Routines developed for pymrio which can also be used independently.
+
+.. autosummary::
+   :toctree: api_doc/
+
+   index_match
+   index_contains
+   index_fullmatch
+   build_agg_matrix
+   build_agg_vec
+   convert_to_long
+
+
 *************
 Miscellaneous
 *************

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -33,19 +33,23 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
+    "sphinx.ext.napoleon",
     "sphinx.ext.autodoc",
     "nbsphinx",
     "IPython.sphinxext.ipython_console_highlighting",
     "sphinx.ext.mathjax",
     "sphinx.ext.coverage",
     "sphinx.ext.autosummary",
-    "sphinx.ext.napoleon",
 ]
 
 nbsphinx_execute = "never"
 
+napoleon_numpy_docstring = True
 napoleon_google_docstring = False
-napoleon_use_param = False
+
+napoleon_include_init_with_doc = False
+napoleon_include_private_with_doc = True
+napoleon_use_param = True
 napoleon_use_ivar = True
 
 # automatically generate api references
@@ -72,9 +76,11 @@
 # built documents.
 #
 # The short X.Y version.
-version = "0.3.dev1"
+
+import pymrio  # noqa
+version = pymrio.__version__
 # The full version, including alpha/beta/rc tags.
-release = "0.3.dev1"
+release = pymrio.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -146,7 +152,7 @@
 # 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"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

diff --git a/doc/source/handling.rst b/doc/source/handling.rst
@@ -4,6 +4,7 @@ Handling MRIO data
 .. toctree::
   :maxdepth: 2
 
+  notebooks/explore
   notebooks/pymrio_directly_assign_attributes
   notebooks/working_with_wiod
   notebooks/working_with_exiobase

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -13,8 +13,8 @@ Contents:
    terminology
    math
    Automatic MRIO download <notebooks/autodownload>
-   notebooks/metadata
    handling
+   notebooks/metadata
    development
    changelog
    api_references