📝 Fix Doc Build (#8)

Co-authored-by: Annika <[email protected]>
Hochfrequenz · Dec 16, 2021 · efbc65b · efbc65b
1 parent ea4d68b
commit efbc65b
Show file tree

Hide file tree

Showing 19 changed files with 439 additions and 292 deletions.
diff --git a/README.rst b/README.rst
@@ -3,6 +3,12 @@ MIG AHB Utility Stack (MAUS) 🐁
 
 | |Unittests status badge| |Coverage status badge| |Linting status badge| |Black status badge| |pypy status badge| |read the docs|
 
+.. image:: https://raw.githubusercontent.com/Hochfrequenz/mig_ahb_utility_stack/main/docs/_static/maus-logo.png
+   :target: https://mig-ahb-utility-stack.readthedocs.io/en/stable/api/maus.html
+   :align: right
+   :alt: maus logo
+   :width: 150px
+
 | This repository contains the Python package ``maus``.
 | MAUS is an acronym for **M**\ IG **A**\ HB **U**\ tility **S**\ tack where MIG stands for **M**\ essage **I**\ mplementation **G**\ uide and AHB stands for **A**\ nwendungs\ **h**\ and\ **b**\ uch.
 | The maus package allows matching single lines from the AHB with fields specified in the MIG.

diff --git a/docs/api/maus.models.rst b/docs/api/maus.models.rst
@@ -0,0 +1,37 @@
+maus.models package
+===================
+
+Submodules
+----------
+
+maus.models.anwendungshandbuch module
+-------------------------------------
+
+.. automodule:: maus.models.anwendungshandbuch
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+maus.models.edifact\_components module
+--------------------------------------
+
+.. automodule:: maus.models.edifact_components
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+maus.models.message\_implementation\_guide module
+-------------------------------------------------
+
+.. automodule:: maus.models.message_implementation_guide
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: maus.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/apidoc/maus.reader.rst → docs/api/maus.reader.rst b/docs/apidoc/maus.reader.rst → docs/api/maus.reader.rst
@@ -4,10 +4,13 @@ maus.reader package
 Submodules
 ----------
 
-.. toctree::
-   :maxdepth: 4
+maus.reader.ahb\_csv\_reader module
+-----------------------------------
 
-   maus.reader.ahb_csv_reader
+.. automodule:: maus.reader.ahb_csv_reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------

diff --git a/docs/apidoc/maus.rst → docs/api/maus.rst b/docs/apidoc/maus.rst → docs/api/maus.rst
@@ -10,14 +10,6 @@ Subpackages
    maus.models
    maus.reader
 
-Submodules
-----------
-
-.. toctree::
-   :maxdepth: 4
-
-   maus.maus
-
 Module contents
 ---------------
 

diff --git a/docs/apidoc/modules.rst → docs/api/modules.rst b/docs/apidoc/modules.rst → docs/api/modules.rst
diff --git a/docs/apidoc/maus.maus.rst b/docs/apidoc/maus.maus.rst
diff --git a/docs/apidoc/maus.models.anwendungshandbuch.rst b/docs/apidoc/maus.models.anwendungshandbuch.rst
diff --git a/docs/apidoc/maus.models.edifact_components.rst b/docs/apidoc/maus.models.edifact_components.rst
diff --git a/docs/apidoc/maus.models.message_implementation_guide.rst b/docs/apidoc/maus.models.message_implementation_guide.rst
diff --git a/docs/apidoc/maus.models.rst b/docs/apidoc/maus.models.rst
diff --git a/docs/apidoc/maus.reader.ahb_csv_reader.rst b/docs/apidoc/maus.reader.ahb_csv_reader.rst