Skip to content
Snippets Groups Projects
Commit a57515c4 authored by CI Bot's avatar CI Bot
Browse files

updated mkdocs file with mermaid and mkdoxy

parent f2ba203d
No related branches found
No related tags found
3 merge requests!55[WEBPAGE] Update style of current unicado page,!18Fix header issue in subpages.,!17Integrate mkdoxy in CI pipeline
Pipeline #1539998 waiting for manual action
# Sizing and analysizing!
Yoho $M = \frac{2}{5}$
!!! tip
!!! danger
```mermaid
graph LR;
A-->B
```
......@@ -95,12 +95,12 @@ The engine will be scaled by the module to match the specific thrust requirement
Moreover, an engine bucket curve and several engine deck plots can be created.
Additionally, the propulsion is integrated in relation to the user settings (e.g. integration of the propulsion on the wing or fuselage, ...).
Depending on the location of the integration, the tool calculates the nacelle and pylon geometry.
Also the mass properties are analyzed.
Also the mass properties are analyzed.
{.overview-item}
|Module Version|Language|License|Documentation|
|:---:|:---:|:---:|---|
|3.0.0|:simple-cplusplus: |GPLv3|[Link](propulsion_design/index.html)|
|3.0.0|:simple-cplusplus: |GPLv3|[Link](propulsion_design/content/index.md)|
---
......
......@@ -36,7 +36,11 @@ markdown_extensions:
line_spans: __span # Adds spans around lines for custom styling.
pygments_lang_class: true # Adds language class to highlighted code for styling consistency.
- pymdownx.details # Enables collapsible details/summary blocks for content hiding/showing.
- pymdownx.superfences # Adds advanced fence syntax for blocks like code or tabs.
- pymdownx.superfences: # Adds advanced fence syntax for blocks like code or tabs.
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.inlinehilite # Allows inline code highlighting within text.
- pymdownx.snippets # Enables code snippets for reusing code blocks across pages.
- pymdownx.critic # Adds Critic Markup support for collaborative editing.
......@@ -58,8 +62,20 @@ extra_css:
# === Plugins ===
plugins:
- search
- mkdoxy:
projects:
propulsion_design:
src-dirs: ../aircraft-design/propulsion_design/
full-doc: True
output: docs/propulsion_design
doxy-cfg:
FILE_PATTERNS: "*cpp *.h"
RECURSIVE: True
EXTRACT_ALL: YES
- glightbox # Plugin for lightbox-style image and content viewing.
# === Theme configuration ===
theme:
name: material # Specifies the theme name (alternatives: material, mkdocs, readthedocs).
......@@ -68,9 +84,18 @@ theme:
custom_dir: overrides # Directory for custom files (like footer).
# Theme colors configuration
palette:
scheme: slate # Sets a dark theme style.
primary: blue grey # Main color of the theme (used for buttons, links, etc.).
accent: red # Accent color for highlights.
- scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
primary: blue grey
accent: red
- scheme: slate
toggle:
icon: material/brightness-3
name: Switch to light mode
primary: green
accent: red
# Feature configurations for navigation and ToC behavior
features:
......@@ -98,9 +123,27 @@ nav: # Customizes the main navigation struc
- Seperate Tool Execution: 'tutorials/seperate-tool-execution.md' # Link to the separate tool execution tutorial page.
- Documentation: # Top-level item for documentation.
- Overview: 'documentation/overview.md' # Overview of modules.
- Aircraft Design: # Subsection for Aircraft Design.
- 'documentation/sizing.md' # Link to sizing module page.
- 'documentation/analysis.md' # Link to analysis module page.
- Aircraft Design:
- Introduction: documentation/aircraft-design.md # Subsection for Aircraft Design.
- Sizing:
- Modules: documentation/sizing.md
- Propulsion Design:
- documentation/propulsion_design/content/index.md
- documentation/propulsion_design/content/engineeringprinciples.md
- documentation/propulsion_design/content/getting-started.md
- documentation/propulsion_design/content/softwarearchitecture.md
- Tutorial:
- documentation/propulsion_design/content/tutorial.md
- documentation/propulsion_design/content/tutorial_engine_extension.md
- documentation/propulsion_design/content/tutorial_fidelity_extension.md
- Additional: documentation/propulsion_design/content/additional.md
- API Reference:
- propulsion_design/classes.md
- propulsion_design/namespaces.md
- propulsion_design/files.md
- propulsion_design/pages.md
- Analsysis:
- Modules: 'documentation/analysis.md' # Link to analysis module page.
- Libraries: 'documentation/libraries.md' # Link to libraries overview.
- Utilities: 'documentation/additional-software.md' # Link to additional software page.
- Workflow: 'workflow.md' # Link to the workflow page.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment