From d60f3b81788f4709c315fa491b01c7a8a801a6d1 Mon Sep 17 00:00:00 2001
From: Stephanie Kemna <6518317+StephanieKemna@users.noreply.github.com>
Date: Fri, 1 Nov 2024 22:01:11 +0100
Subject: [PATCH] update docs, remove automodule stuff that does not seem to
 add anything, change ordering, remove unncessary stuff, demote one header to
 remove from index in docs

---
 README.md                           |  2 +-
 docs/source/cli.rst                 | 14 +++++++-------
 docs/source/conf.py                 |  2 +-
 docs/source/index.rst               |  7 +++----
 docs/source/mlfmu.api.rst           |  7 -------
 docs/source/mlfmu.rst               | 22 ----------------------
 docs/source/mlfmu.utils.logging.rst |  7 -------
 docs/source/mlfmu.utils.rst         | 15 ---------------
 8 files changed, 12 insertions(+), 64 deletions(-)
 delete mode 100644 docs/source/mlfmu.api.rst
 delete mode 100644 docs/source/mlfmu.rst
 delete mode 100644 docs/source/mlfmu.utils.logging.rst
 delete mode 100644 docs/source/mlfmu.utils.rst

diff --git a/README.md b/README.md
index 1905e42..80324cd 100644
--- a/README.md
+++ b/README.md
@@ -124,7 +124,7 @@ or if the files are in your current working directory:
 mlfmu build
 ```
 
-# Extended documentation
+## Extended documentation
 
 For more explanation on the ONNX file structure and inputs/outputs for your model, please refer to mlfmu's [MLMODEL.md](MLMODEL.md).
 
diff --git a/docs/source/cli.rst b/docs/source/cli.rst
index 0206547..95b6c61 100644
--- a/docs/source/cli.rst
+++ b/docs/source/cli.rst
@@ -1,7 +1,7 @@
-CLI Documentation
-=================
-
-.. toctree::
-   :maxdepth: 2
-
-   cli.mlfmu
+CLI Documentation
+=================
+
+.. toctree::
+   :maxdepth: 3
+
+   cli.mlfmu
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 9ea7c38..291c7f8 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -23,7 +23,7 @@
 
 project = "mlfmu"
 copyright = "2024, DNV AS. All rights reserved."
-author = "Author One, Author Two, Author Three"
+author = "Kristoffer Skare, Jorge Luis Mendez, Stephanie Kemna, Melih Akdag"
 
 # The full version, including alpha/beta/rc tags
 release = "0.1.6"
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 7c84969..f007f4d 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -7,19 +7,18 @@ mlfmu: Example Python Package
 =========================================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: Contents:
 
    README
    MLMODEL
    ADVANCED
+   cli
+   api
    CHANGELOG
    STYLEGUIDE
    LICENSE
    LICENSE_THIRD_PARTY
-   api
-   cli
-   mlfmu
 
 Indices and tables
 ==================
diff --git a/docs/source/mlfmu.api.rst b/docs/source/mlfmu.api.rst
deleted file mode 100644
index 0fce133..0000000
--- a/docs/source/mlfmu.api.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-mlfmu.api module
-================
-
-.. autoclass:: mlfmu.api
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/mlfmu.rst b/docs/source/mlfmu.rst
deleted file mode 100644
index b4df248..0000000
--- a/docs/source/mlfmu.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-mlfmu package
-=============
-
-.. automodule:: mlfmu
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Subpackages
------------
-
-.. toctree::
-   :maxdepth: 2
-
-Submodules
-----------
-
-.. toctree::
-   :maxdepth: 2
-
-   mlfmu.api
-   mlfmu.utils
diff --git a/docs/source/mlfmu.utils.logging.rst b/docs/source/mlfmu.utils.logging.rst
deleted file mode 100644
index 9f8929f..0000000
--- a/docs/source/mlfmu.utils.logging.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-mlfmu.utils.logging module
-==============================
-
-.. autoclass:: mlfmu.utils.logging
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/mlfmu.utils.rst b/docs/source/mlfmu.utils.rst
deleted file mode 100644
index 28c0c9f..0000000
--- a/docs/source/mlfmu.utils.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-mlfmu.utils package
-=======================
-
-.. autoclass:: mlfmu.utils
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Submodules
-----------
-
-.. toctree::
-   :maxdepth: 2
-
-   mlfmu.utils.logging