Skip to content
Snippets Groups Projects
Commit e71e45e6 authored by Alfin Johny's avatar Alfin Johny
Browse files

Fix documentation issues

parent fe3553e2
No related branches found
No related tags found
2 merge requests!55[WEBPAGE] Update style of current unicado page,!17Integrate mkdoxy in CI pipeline
Pipeline #1591455 waiting for manual action
Stage: build
Stage: deploy
Hide whitespace changes
Inline Side-by-side
docs/documentation/libraries.md
+ 1
− 1
View file @ e71e45e6
...@@ -8,7 +8,7 @@ date: 2024-11-28 ...@@ -8,7 +8,7 @@ date: 2024-11-28
glightbox: false glightbox: false
--- ---
As mentioned in the [build instructions](../developer/build/general.md), we have some external dependencies to: As mentioned in the [build instructions](../get-involved/build/general.md), we have some external dependencies to:
- :simple-cplusplus: [Eigen3 :octicons-link-external-16:](https://eigen.tuxfamily.org/index.php?title=Main_Page){:target="_blank"} - :simple-cplusplus: [Eigen3 :octicons-link-external-16:](https://eigen.tuxfamily.org/index.php?title=Main_Page){:target="_blank"}
- :simple-cplusplus: [Boost :octicons-link-external-16:](https://www.boost.org/){:target="_blank"} - :simple-cplusplus: [Boost :octicons-link-external-16:](https://www.boost.org/){:target="_blank"}
......
docs/download/getting-started.md → docs/download/getting_started.md
+ 6
− 6
View file @ e71e45e6
You want to **use** UNICADO to get familiar with the workflow and see first results? Great :fire: Then check out the [Installation Guide](installation.md) and the [Cleared for Take-Off](takeoff.md). It includes the prerequisites, troubleshooting hints and a standalone installer. You want to **use** UNICADO to get familiar with the workflow and see first results? Great :fire: Then check out the [Installation Guide](installation.md) and the [Cleared for Take-Off](takeoff.md). It includes the prerequisites, troubleshooting hints and a standalone installer.
If you're a **developer** interested in contributing to UNICADO, follow the [Developer Installation Guide](../get-involved/developer-installation.md). However, you also need to check out the [Installation Requirements](installation.md) first! If you're a **developer** interested in contributing to UNICADO, follow the [Developer Installation Guide](../get-involved/developer-installation.md). However, you also need to check out the [Installation Requirements](installation.md) first!
docs/get-involved/testing.md
+ 1
− 1
View file @ e71e45e6
...@@ -117,7 +117,7 @@ Then you can execute the test ...@@ -117,7 +117,7 @@ Then you can execute the test
### Automated testing {#automated} ### Automated testing {#automated}
To reduce the workload of the developer, tests can be automated. For that, the additional software [testFramework](../documentation/additional-software.md) can be used. It can be executed manually (see [python build instruction](../get-involved/build/python.md)) or be linked to the CI/CD pipeline. The latter one ensures that it is tested before every merge request. To reduce the workload of the developer, tests can be automated. For that, the additional software [testFramework](../documentation/additional_software.md) can be used. It can be executed manually (see [python build instruction](../get-involved/build/python.md)) or be linked to the CI/CD pipeline. The latter one ensures that it is tested before every merge request.
!!! attention !!! attention
The `testFramework` is currently under construction :construction: and still needs to be linked to the CI/CD pipeline The `testFramework` is currently under construction :construction: and still needs to be linked to the CI/CD pipeline
......
docs/index.md
+ 1
− 1
View file @ e71e45e6
...@@ -31,7 +31,7 @@ hide: ...@@ -31,7 +31,7 @@ hide:
Learn how to set it up & install the prerequisites. Learn how to set it up & install the prerequisites.
[:octicons-arrow-right-24: Download](download/getting-started.md) [:octicons-arrow-right-24: Download](download/getting_started.md)
</div> </div>
<div class="grid-item card" markdown="1"> <div class="grid-item card" markdown="1">
......
mkdocs.yml
+ 14
− 13
View file @ e71e45e6
...@@ -167,7 +167,7 @@ theme: ...@@ -167,7 +167,7 @@ theme:
nav: # Customizes the main navigation structure of the site. nav: # Customizes the main navigation structure of the site.
- Home: index.md # Main page of the site. - Home: index.md # Main page of the site.
- Download: # Top-level navigation item for "Download". - Download: # Top-level navigation item for "Download".
- Getting Started: download/getting-started.md # Link to the getting started page. - Getting Started: download/getting_started.md # Link to the getting started page.
- Installation: download/installation.md # Link to the installation page. - Installation: download/installation.md # Link to the installation page.
- Cleared for Take-Off: download/takeoff.md # Link to the takeoff/getting started page. - Cleared for Take-Off: download/takeoff.md # Link to the takeoff/getting started page.
- Tutorials: - Tutorials:
...@@ -181,7 +181,8 @@ nav: # Customizes the main navigation struc ...@@ -181,7 +181,8 @@ nav: # Customizes the main navigation struc
- Modules: documentation/sizing.md # Link to aircraft sizing documentation. - Modules: documentation/sizing.md # Link to aircraft sizing documentation.
- Initial Sizing: - Initial Sizing:
- Introduction: documentation/aircraft-design/initial_sizing/doc/content/index.md - Introduction: documentation/aircraft-design/initial_sizing/doc/content/index.md
- Getting Staretd: documentation/aircraft-design/initial_sizing/doc/content/getting-started.md - Getting Staretd: documentation/aircraft-design/initial_sizing/doc/content/getting_started.md
- Changelog: documentation/aircraft-design/initial_sizing/doc/content/changelog.md
- API Reference: - API Reference:
- initial_sizing/classes.md - initial_sizing/classes.md
- initial_sizing/namespaces.md - initial_sizing/namespaces.md
...@@ -190,7 +191,7 @@ nav: # Customizes the main navigation struc ...@@ -190,7 +191,7 @@ nav: # Customizes the main navigation struc
- initial_sizing/pages.md - initial_sizing/pages.md
- Create Mission XML: - Create Mission XML:
- Introduction: documentation/aircraft-design/create_mission_xml/doc/content/index.md - Introduction: documentation/aircraft-design/create_mission_xml/doc/content/index.md
- Getting Staretd: documentation/aircraft-design/create_mission_xml/doc/content/getting-started.md - Getting Staretd: documentation/aircraft-design/create_mission_xml/doc/content/getting_started.md
- API Reference: - API Reference:
- create_mission_xml/classes.md - create_mission_xml/classes.md
- create_mission_xml/namespaces.md - create_mission_xml/namespaces.md
...@@ -199,7 +200,7 @@ nav: # Customizes the main navigation struc ...@@ -199,7 +200,7 @@ nav: # Customizes the main navigation struc
- create_mission_xml/pages.md - create_mission_xml/pages.md
- Fuselage Design: - Fuselage Design:
- Introduction: documentation/aircraft-design/fuselage_design/doc/content/index.md - Introduction: documentation/aircraft-design/fuselage_design/doc/content/index.md
- Getting Staretd: documentation/aircraft-design/fuselage_design/doc/content/getting-started.md - Getting Staretd: documentation/aircraft-design/fuselage_design/doc/content/getting_started.md
- API Reference: - API Reference:
- fuselage_design/classes.md - fuselage_design/classes.md
- fuselage_design/namespaces.md - fuselage_design/namespaces.md
...@@ -208,7 +209,7 @@ nav: # Customizes the main navigation struc ...@@ -208,7 +209,7 @@ nav: # Customizes the main navigation struc
- fuselage_design/pages.md - fuselage_design/pages.md
- Wing Design: - Wing Design:
- Introduction: documentation/aircraft-design/wing_design/doc/content/index.md - Introduction: documentation/aircraft-design/wing_design/doc/content/index.md
- Getting Staretd: documentation/aircraft-design/wing_design/doc/content/getting-started.md - Getting Staretd: documentation/aircraft-design/wing_design/doc/content/getting_started.md
- API Reference: - API Reference:
- wing_design/classes.md - wing_design/classes.md
- wing_design/namespaces.md - wing_design/namespaces.md
...@@ -217,7 +218,7 @@ nav: # Customizes the main navigation struc ...@@ -217,7 +218,7 @@ nav: # Customizes the main navigation struc
- wing_design/pages.md - wing_design/pages.md
- Empennage Design: - Empennage Design:
- Introduction: documentation/aircraft-design/empennage_design/doc/content/index.md - Introduction: documentation/aircraft-design/empennage_design/doc/content/index.md
- Getting Staretd: documentation/aircraft-design/empennage_design/doc/content/getting-started.md - Getting Staretd: documentation/aircraft-design/empennage_design/doc/content/getting_started.md
- API Reference: - API Reference:
- empennage_design/classes.md - empennage_design/classes.md
- empennage_design/namespaces.md - empennage_design/namespaces.md
...@@ -226,7 +227,7 @@ nav: # Customizes the main navigation struc ...@@ -226,7 +227,7 @@ nav: # Customizes the main navigation struc
- empennage_design/pages.md - empennage_design/pages.md
- Tank Design: - Tank Design:
- Introduction: documentation/aircraft-design/tank_design/doc/content/index.md - Introduction: documentation/aircraft-design/tank_design/doc/content/index.md
- Getting Staretd: documentation/aircraft-design/tank_design/doc/content/getting-started.md - Getting Staretd: documentation/aircraft-design/tank_design/doc/content/getting_started.md
- API Reference: - API Reference:
- tank_design/classes.md - tank_design/classes.md
- tank_design/namespaces.md - tank_design/namespaces.md
...@@ -243,7 +244,7 @@ nav: # Customizes the main navigation struc ...@@ -243,7 +244,7 @@ nav: # Customizes the main navigation struc
- Engine Extension: documentation/aircraft-design/propulsion_design/doc/content/tutorial_engine_extension.md - Engine Extension: documentation/aircraft-design/propulsion_design/doc/content/tutorial_engine_extension.md
- Fidelity Extension: documentation/aircraft-design/propulsion_design/doc/content/tutorial_fidelity_extension.md - Fidelity Extension: documentation/aircraft-design/propulsion_design/doc/content/tutorial_fidelity_extension.md
- Changelog: documentation/aircraft-design/propulsion_design/doc/content/changelog.md - Changelog: documentation/aircraft-design/propulsion_design/doc/content/changelog.md
- Additional: documentation/aircraft-design/propulsion_design/doc/content/additional.md - Additional Information: documentation/aircraft-design/propulsion_design/doc/content/additional.md
- API Reference: - API Reference:
- propulsion_design/classes.md - propulsion_design/classes.md
- propulsion_design/namespaces.md - propulsion_design/namespaces.md
...@@ -252,7 +253,7 @@ nav: # Customizes the main navigation struc ...@@ -252,7 +253,7 @@ nav: # Customizes the main navigation struc
- propulsion_design/pages.md - propulsion_design/pages.md
- Landing Gear Design: - Landing Gear Design:
- Introduction: documentation/aircraft-design/landing_gear_design/doc/content/index.md - Introduction: documentation/aircraft-design/landing_gear_design/doc/content/index.md
- Getting Staretd: documentation/aircraft-design/landing_gear_design/doc/content/getting-started.md - Getting Staretd: documentation/aircraft-design/landing_gear_design/doc/content/getting_started.md
- API Reference: - API Reference:
- landing_gear_design/classes.md - landing_gear_design/classes.md
- landing_gear_design/namespaces.md - landing_gear_design/namespaces.md
...@@ -261,7 +262,7 @@ nav: # Customizes the main navigation struc ...@@ -261,7 +262,7 @@ nav: # Customizes the main navigation struc
- landing_gear_design/pages.md - landing_gear_design/pages.md
- Systems Design: - Systems Design:
- Introduction: documentation/aircraft-design/systems_design/doc/content/index.md - Introduction: documentation/aircraft-design/systems_design/doc/content/index.md
- Getting Staretd: documentation/aircraft-design/systems_design/doc/content/getting-started.md - Getting Staretd: documentation/aircraft-design/systems_design/doc/content/getting_started.md
- API Reference: - API Reference:
- systems_design/classes.md - systems_design/classes.md
- systems_design/namespaces.md - systems_design/namespaces.md
...@@ -282,9 +283,9 @@ nav: # Customizes the main navigation struc ...@@ -282,9 +283,9 @@ nav: # Customizes the main navigation struc
- MSYS2/MinGW (deprecated): get-involved/build-environment/mingw.md - MSYS2/MinGW (deprecated): get-involved/build-environment/mingw.md
- Get Source Code: get-involved/get-source-code.md - Get Source Code: get-involved/get-source-code.md
- Build: - Build:
- General: get-involved/general.md - General: get-involved/build/general.md
- C++: get-involved/cpp.md - C++: get-involved/build/cpp.md
- Python: get-involved/python.md - Python: get-involved/build/python.md
- Include Libraries: get-involved/including-libraries.md - Include Libraries: get-involved/including-libraries.md
- CMake Presets: get-involved/cmake-presets.md - CMake Presets: get-involved/cmake-presets.md
- Module Development: - Module Development:
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment