update docs, remove automodule stuff that does not seem to add anythi…

…ng, change ordering, remove unncessary stuff, demote one header to remove from index in docs
dnv-opensource · Nov 1, 2024 · d60f3b8 · d60f3b8
1 parent f6eb716
commit d60f3b8
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 64 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
diff --git a/docs/source/mlfmu.rst b/docs/source/mlfmu.rst
diff --git a/docs/source/mlfmu.utils.logging.rst b/docs/source/mlfmu.utils.logging.rst
diff --git a/docs/source/mlfmu.utils.rst b/docs/source/mlfmu.utils.rst