From c9c75336b150a0aaecd236c3717fd6b8c5f0c2d3 Mon Sep 17 00:00:00 2001
From: staudtMarius <marius.staudt@tu-dortmund.de>
Date: Fri, 28 Nov 2025 15:42:54 +0100
Subject: [PATCH] Added API structure to the docs

---
 CHANGELOG.md                  |  1 +
 docs/readthedocs/conf.py      |  4 ++--
 docs/readthedocs/index.md     |  1 +
 docs/readthedocs/structure.md | 45 +++++++++++++++++++++++++++++++++++
 4 files changed, 49 insertions(+), 2 deletions(-)
 create mode 100644 docs/readthedocs/structure.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 6858b506..0aaf9b71 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 - Enhanced `ExtEmDataConnection` with `simulateInternal` method [#398](https://github.com/ie3-institute/simonaAPI/issues/398)
+- Added API structure to the docs [#405](https://github.com/ie3-institute/simonaAPI/issues/405)
 
 ### Changed
 
diff --git a/docs/readthedocs/conf.py b/docs/readthedocs/conf.py
index fa091f3c..760bbb07 100644
--- a/docs/readthedocs/conf.py
+++ b/docs/readthedocs/conf.py
@@ -22,8 +22,8 @@
 author = 'Institute of Energy Systems, Energy Efficiency and Energy Economics'
 
 # The full version, including alpha/beta/rc tags
-version = '0.6.0'
-release = '0.6.0'
+version = '0.12.0'
+release = '0.12.0'
 
 pygments_style = 'tango'
 add_function_parentheses = True
diff --git a/docs/readthedocs/index.md b/docs/readthedocs/index.md
index e6a59247..e70fc330 100644
--- a/docs/readthedocs/index.md
+++ b/docs/readthedocs/index.md
@@ -10,6 +10,7 @@ One example are external simulations, that can be used in co-simulations with SI
 :maxdepth: 2
 
 gettingstarted
+structure
 createextsims
 extlinkinterface
 
diff --git a/docs/readthedocs/structure.md b/docs/readthedocs/structure.md
new file mode 100644
index 00000000..29e1ff9e
--- /dev/null
+++ b/docs/readthedocs/structure.md
@@ -0,0 +1,45 @@
+# API Structure
+
+This page is mend to provide an overview of the structure of this API.
+
+The API is split into the following parts:
+1. [Data](#data)
+2. [Exceptions](#exceptions)
+3. [Mapping](#mapping)
+4. [Ontology](#ontology)
+5. [Simulation](#simulation)
+6. [Uncategorized](#uncategorized)
+
+## Data
+
+The data package and its sub-packages contains all data-related classes. These are among other things [data connections](/connections/connections),
+data containers and models.
+
+
+## Exceptions
+
+This package contains some exceptions. These can be thrown by the classes of this API.
+
+
+## Mapping
+
+This package contains the `ExtEntityMapping` as well as some `DataTypes` and the `ExtEntityEntry` that are both used in
+the mapping.
+
+## Ontology
+
+All messages that can be exchanged between SIMONA and an external simulation resp. data connection are placed in this
+package.
+
+
+## Simulation
+
+The simulation package contains the available simulations. Currently, only base classes that needs to be implemented are
+provided. The most important class is the [ExtSimulation](/simulations/externalsimulation) as it is the base class for
+all external simulations.
+
+
+## Uncategorized
+
+There is currently only one interface that is not part of a category. This is the [ExtLinkInterface](/extlinkinterface)
+that is used for loading external simulations.