From d7d3fedec3fff9a9848eb7f34b394966254075c4 Mon Sep 17 00:00:00 2001
From: Sebastian Oberschwendtner <sebastian.oberschwendtner@tum.de>
Date: Fri, 8 Sep 2023 07:45:32 +0200
Subject: [PATCH] First layout for including doxygen output in site.

---
 .gitignore                                 |   2 +
 docs/contact.md                            |   0
 docs/description.md                        |   7 +-
 docs/developer/build-instructions.md       |   8 +
 docs/developer/setup.md                    |   7 +
 docs/{ => getting-started}/installation.md |   0
 docs/getting-started/takeoff.md            |   0
 docs/impressum.md                          |   0
 docs/license.md                            |   0
 docs/module-overview.md                    | 311 +++++++++++++++++++++
 docs/partners.md                           |   0
 mkdocs.yml                                 |  21 ++
 12 files changed, 355 insertions(+), 1 deletion(-)
 create mode 100644 .gitignore
 create mode 100644 docs/contact.md
 create mode 100644 docs/developer/build-instructions.md
 create mode 100644 docs/developer/setup.md
 rename docs/{ => getting-started}/installation.md (100%)
 create mode 100644 docs/getting-started/takeoff.md
 create mode 100644 docs/impressum.md
 create mode 100644 docs/license.md
 create mode 100644 docs/module-overview.md
 create mode 100644 docs/partners.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..7813adc
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+# Ignore generated Doxygen docs in modules folder
+/docs/modules/
diff --git a/docs/contact.md b/docs/contact.md
new file mode 100644
index 0000000..e69de29
diff --git a/docs/description.md b/docs/description.md
index 53be73e..449ee9e 100644
--- a/docs/description.md
+++ b/docs/description.md
@@ -1,6 +1,11 @@
 ## General Description
 The general overview of the UNICADO process chain is shown below.
-![Overview UNICADO Process](assets/images/unicado_module_chain_v3.jpg)
+<figure markdown>
+  ![Overview UNICADO Process](assets/images/unicado_module_chain_v3.jpg){width="500"}
+  <figcaption>Overview UNICADO Process</figcaption>
+</figure>
+
+
 
 ## Module Descriptions
 
diff --git a/docs/developer/build-instructions.md b/docs/developer/build-instructions.md
new file mode 100644
index 0000000..b290864
--- /dev/null
+++ b/docs/developer/build-instructions.md
@@ -0,0 +1,8 @@
+---
+title: Build Instructions
+summary: Contains the instruction to get the build process up and running.
+authors:
+    - Sebastian Oberschwendtner
+date: 2023-09-06
+---
+# Build Instructions
\ No newline at end of file
diff --git a/docs/developer/setup.md b/docs/developer/setup.md
new file mode 100644
index 0000000..de84812
--- /dev/null
+++ b/docs/developer/setup.md
@@ -0,0 +1,7 @@
+---
+title: Software Development Setup
+summary: How to setup the environment to successfully contribute to UNICADO.
+authors:
+    - Sebastian Oberschwendtner
+date: 2023-09-06
+---
diff --git a/docs/installation.md b/docs/getting-started/installation.md
similarity index 100%
rename from docs/installation.md
rename to docs/getting-started/installation.md
diff --git a/docs/getting-started/takeoff.md b/docs/getting-started/takeoff.md
new file mode 100644
index 0000000..e69de29
diff --git a/docs/impressum.md b/docs/impressum.md
new file mode 100644
index 0000000..e69de29
diff --git a/docs/license.md b/docs/license.md
new file mode 100644
index 0000000..e69de29
diff --git a/docs/module-overview.md b/docs/module-overview.md
new file mode 100644
index 0000000..ec2018f
--- /dev/null
+++ b/docs/module-overview.md
@@ -0,0 +1,311 @@
+UNICADO collects the following software modules.
+The modules are grouped into:
+
+- [ Aircraft Design ](#aircraft-design)
+- [ Libraries ](#libraries)
+- [Additional Software](#additional-software)
+
+## Aircraft Design
+
+---
+
+### Component Sizing
+#### createMissionXML
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+#### createMissionXML
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+#### empennageSizing
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+#### engineSizing
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+#### fuselageDesign
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+#### hydrogenTank
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-python: |GPLv3|[Link]()|
+
+#### initialSizing
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+#### landingGearDesign
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+#### propulsionIntegration
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+#### systemsDesign
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+#### wingDesign
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+---
+
+### Design Analysis
+#### calculateEmissions
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+#### calculatePerformance
+![Icon](assets/images/icon.png){width=200  align=left}
+The module `calculatePerformance` is used to evaluate the mission performance of the design.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus:| GPLv3 |[Link]()|
+
+#### calculatePolar
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+#### costEstimation
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-python: |GPLv3|[Link]()|
+
+#### massEstimation
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+#### missionAnalysis
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+---
+
+## Libraries
+#### aerodynamics
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### aircraftGeometry
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.0.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### aircraftGeometry2
+![Icon](assets/images/icon.png){width=200  align=left}
+This library is based on the older [aircraftGeometry](#aircraftgeometry) library and extends it to be more modular.
+The modularity and flexibility is achieved by using the high performance [Computational Geometry Algorithms Library](https://www.cgal.org/) also known as **CGAL**.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link](modules/aircraftGeometry2/index.html)|
+
+### aircraftNetwork
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### aixml
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### atmosphere
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### engine
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### liftingLineInterface
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### moduleBasics
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### propulsionsystem
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### runtimeInfo
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### spline
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### standardFiles
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### svgPlot
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### unitConversion
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+---
+
+## Additional Software
+### cpacsInterface
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### designEvaluator
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### reportGenerator
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+### testFramework
+![Icon](assets/images/icon.png){width=200  align=left}
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
+
+|Module Version|Language|License|Documentation|
+|:---:|:---:|:---:|---|
+|2.1.0|:simple-cplusplus: |GPLv3|[Link]()|
+
+---
\ No newline at end of file
diff --git a/docs/partners.md b/docs/partners.md
new file mode 100644
index 0000000..e69de29
diff --git a/mkdocs.yml b/mkdocs.yml
index 0a54a09..4cd94fb 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -21,6 +21,7 @@ site_name: UNICADO
 markdown_extensions:
   - attr_list
   - admonition
+  - md_in_html
   - pymdownx.details
   - pymdownx.superfences
   - toc:
@@ -39,5 +40,25 @@ theme:
     primary: blue grey
     accent: lime
   features:
+  - navigation.path
   - navigation.top
+  - navigation.tabs
   - toc.follow
+
+# === Page Tree ===
+nav:
+  - 'Home':
+    - 'index.md'
+    - 'description.md'
+    - 'partners.md'
+  - 'Module Overview': 'module-overview.md'
+  - 'Getting Started':
+    - 'getting-started/installation.md'
+    - 'getting-started/takeoff.md'
+  - 'Developer':
+    - 'developer/build-instructions.md'
+    - 'developer/setup.md'
+  - 'About':
+    - 'license.md'
+    - 'contact.md'
+  - 'impressum.md'
\ No newline at end of file
-- 
GitLab