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

Fix/api issues

parent 2950ea62
No related branches found
No related tags found
2 merge requests!73Initial open source version,!70Fix/api issues
Hide whitespace changes
Inline Side-by-side
.gitlab-ci.yml
+ 7
− 6
View file @ 088abf53
...@@ -33,10 +33,10 @@ clone: ...@@ -33,10 +33,10 @@ clone:
# clone repos # clone repos
- git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@git.rwth-aachen.de/unicado/aircraft-design - git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@git.rwth-aachen.de/unicado/aircraft-design
- cd aircraft-design - cd aircraft-design
- git clone --recurse-submodules https://gitlab-ci-token:${CI_JOB_TOKEN}@git.rwth-aachen.de/unicado/libraries libs/ # Clone libraries inside the aircraft-design directory
# Change to the project directory (useful for multi-directory repositories) - git clone --recurse-submodules https://gitlab-ci-token:${CI_JOB_TOKEN}@git.rwth-aachen.de/unicado/libraries lib
# Change to the project directory (useful for multi-directory repositories)
- cd $CI_PROJECT_DIR - cd $CI_PROJECT_DIR
- ls -la $CI_PROJECT_DIR
artifacts: artifacts:
# Save the generated documentation as artifacts so they can be accessed later in the pipeline # Save the generated documentation as artifacts so they can be accessed later in the pipeline
paths: paths:
...@@ -49,8 +49,7 @@ clone: ...@@ -49,8 +49,7 @@ clone:
- if: '$CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH' # Allow manual triggers on non-default branches - if: '$CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH' # Allow manual triggers on non-default branches
when: manual # Run only when triggered manually when: manual # Run only when triggered manually
- if: '$CI_PIPELINE_SOURCE == "trigger"' # Triggered by another pipeline - if: '$CI_PIPELINE_SOURCE == "trigger"' # Triggered by another pipeline
when: on_success # Run if the source pipeline was successful when: on_success # Run if the source pipeline was successful
# === Build and deploy the website === # === Build and deploy the website ===
pages: pages:
image: python:latest image: python:latest
...@@ -79,4 +78,6 @@ pages: ...@@ -79,4 +78,6 @@ pages:
- if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH' # Run when the commit is on the default branch - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH' # Run when the commit is on the default branch
when: on_success # Only run if the previous jobs are successful when: on_success # Only run if the previous jobs are successful
- if: '$CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH' # Allow manual triggers on non-default branches - if: '$CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH' # Allow manual triggers on non-default branches
when: manual # Run only when triggered manually when: manual # Run only when triggered manually
\ No newline at end of file - if: '$CI_PIPELINE_SOURCE == "trigger"' # Triggered by another pipeline
when: on_success # Run if the source pipeline was successful
\ No newline at end of file
mkdocs.yml
+ 145
− 145
View file @ 088abf53
...@@ -73,145 +73,145 @@ plugins: ...@@ -73,145 +73,145 @@ plugins:
- mkdoxy: - mkdoxy:
projects: projects:
propulsion_design: propulsion_design:
doxyfile: Doxyfile src-dirs: aircraft-design/propulsion_design/src
variables:
PROJECT_NAME: "propulsion_design"
OUTPUT_DIR: "docs/api/propulsion"
BIBTEX_FILE: "docs/assets/bibtex/propulsion_design_literature.bib"
src-dirs: ../aircraft-design/propulsion_design/src/
full-doc: True
ecological_assessment:
doxyfile: Doxyfile
variables:
PROJECT_NAME: "ecological_assessment"
OUTPUT_DIR: "docs/api/ecological_assessment"
BIBTEX_FILE: "docs/assets/bibtex/ecological_assessment_literature.bib"
src-dirs: ../aircraft-design/ecological_assessment/src/
full-doc: True full-doc: True
doxy-cfg:
FILE_PATTERNS: "*.cpp *.h"
RECURSIVE: True
EXTRACT_ALL: YES
OUTPUT_DIRECTORY: "./docs/propulsion_design"
BIBTEX_FILE: docs/assets/bibtex/propulsion_design_literature.bib
initial_sizing: initial_sizing:
doxyfile: Doxyfile src-dirs: aircraft-design/initial_sizing/src
variables:
PROJECT_NAME: "initial_sizing"
OUTPUT_DIR: "docs/api/initial_sizing"
BIBTEX_FILE: "docs/assets/bibtex/initial_sizing_literature.bib"
src-dirs: ../aircraft-design/initial_sizing/src/
full-doc: true full-doc: true
doxy-cfg:
OUTPUT_DIRECTORY: "./docs/initial_sizing"
FILE_PATTERNS: "*.cpp *.h"
RECURSIVE: True
EXTRACT_ALL: YES
create_mission_xml: create_mission_xml:
doxyfile: Doxyfile src-dirs: aircraft-design/create_mission_xml/src
variables: full-doc: True
PROJECT_NAME: "create_mission_xml" doxy-cfg:
OUTPUT_DIR: "docs/api/create_mission_xml" OUTPUT_DIRECTORY: "./docs/create_mission_xml"
BIBTEX_FILE: "docs/assets/bibtex/create_mission_xml_literature.bib" FILE_PATTERNS: "*.cpp *.h"
src-dirs: ../aircraft-design/create_mission_xml/src/ RECURSIVE: True
full-doc: true EXTRACT_ALL: YES
BIBTEX_FILE: docs/assets/bibtex/create_mission_xml_literature.bib
fuselage_design: fuselage_design:
doxyfile: Doxyfile src-dirs: aircraft-design/fuselage_design/src
variables:
PROJECT_NAME: "fuselage_design"
OUTPUT_DIR: "docs/api/fuselage_design"
BIBTEX_FILE: "docs/assets/bibtex/fuselage_design_literature.bib"
src-dirs: ../aircraft-design/fuselage_design/src/
full-doc: true full-doc: true
doxy-cfg:
OUTPUT_DIRECTORY: "./docs/fuselage_design"
FILE_PATTERNS: "*.cpp *.h"
RECURSIVE: True
EXTRACT_ALL: YES
wing_design: wing_design:
doxyfile: Doxyfile src-dirs: aircraft-design/wing_design/src
variables:
PROJECT_NAME: "wing_design"
OUTPUT_DIR: "docs/api/wing_design"
BIBTEX_FILE: "docs/assets/bibtex/wing_design_literature.bib"
src-dirs: ../aircraft-design/wing_design/src/
full-doc: True full-doc: True
doxy-cfg:
OUTPUT_DIRECTORY: "./docs/wing_design"
FILE_PATTERNS: "*.cpp *.h"
RECURSIVE: True
EXTRACT_ALL: YES
empennage_design: empennage_design:
doxyfile: Doxyfile src-dirs: aircraft-design/empennage_design/src
variables:
PROJECT_NAME: "empennage_design"
OUTPUT_DIR: "docs/api/empennage_design"
src-dirs: ../aircraft-design/empennage_design/src/
full-doc: true full-doc: true
doxy-cfg:
FILE_PATTERNS: "*.cpp *.h"
RECURSIVE: True
EXTRACT_ALL: YES
OUTPUT_DIRECTORY: "./docs/empennage_design"
tank_design: tank_design:
doxyfile: Doxyfile src-dirs: aircraft-design/tank_design/src
variables:
PROJECT_NAME: "tank_design"
OUTPUT_DIR: "docs/api/tank_design"
src-dirs: ../aircraft-design/tank_design/src/
full-doc: true full-doc: true
doxy-cfg:
FILE_PATTERNS: "*.cpp *.h"
RECURSIVE: True
EXTRACT_ALL: YES
OUTPUT_DIRECTORY: "./docs/tank_design"
landing_gear_design: landing_gear_design:
doxyfile: Doxyfile src-dirs: aircraft-design/landing_gear_design/src
variables:
PROJECT_NAME: "landing_gear_design"
OUTPUT_DIR: "docs/api/landing_gear_design"
src-dirs: ../aircraft-design/landing_gear_design/src/
full-doc: true full-doc: true
doxy-cfg:
FILE_PATTERNS: "*.cpp *.h"
RECURSIVE: True
EXTRACT_ALL: YES
OUTPUT_DIRECTORY: "./docs/landing_gear_design"
systems_design: systems_design:
doxyfile: Doxyfile src-dirs: aircraft-design/systems_design/src
variables: full-doc: true
PROJECT_NAME: "systems_design" doxy-cfg:
OUTPUT_DIR: "docs/api/systems_design" FILE_PATTERNS: "*.cpp *.h"
src-dirs: ../aircraft-design/systems_design/src/ RECURSIVE: True
EXTRACT_ALL: YES
OUTPUT_DIRECTORY: "./docs/systems_design"
ecological_assessment:
src-dirs: aircraft-design/ecological_assessment/src
full-doc: true full-doc: true
doxy-cfg:
FILE_PATTERNS: "*.cpp *.h"
RECURSIVE: True
EXTRACT_ALL: YES
OUTPUT_DIRECTORY: "./docs/ecological_assessment"
BIBTEX_FILE: docs/assets/bibtex/ecological_assessment_literature.bib
aerodynamic_analysis: aerodynamic_analysis:
doxyfile: Doxyfile src-dirs: aircraft-design/aerodynamic_analysis/src
variables:
PROJECT_NAME: "aerodynamic_analysis"
OUTPUT_DIR: "docs/api/aerodynamic_analysis"
src-dirs: ../aircraft-design/aerodynamic_analysis/src/
full-doc: true full-doc: true
doxy-cfg:
FILE_PATTERNS: "*.cpp *.h"
RECURSIVE: True
EXTRACT_ALL: YES
OUTPUT_DIRECTORY: "./docs/aerodynamic_analysis"
aircraftGeometry2: aircraftGeometry2:
doxyfile: Doxyfile src-dirs: aircraft-design/libs/aircraftGeometry2/src
variables:
PROJECT_NAME: "aircraftGeometry2"
OUTPUT_DIR: "docs/api/aircraftGeometry2"
src-dirs: ../aircraft-design/libs/aircraftGeometry2/src/
full-doc: true full-doc: true
doxy-cfg:
FILE_PATTERNS: "*.cpp *.h"
RECURSIVE: True
EXTRACT_ALL: YES
OUTPUT_DIRECTORY: "./docs/aircraftGeometry2"
engine: engine:
doxyfile: Doxyfile src-dirs: aircraft-design/libs/engine/src
variables:
PROJECT_NAME: "engine"
OUTPUT_DIR: "docs/api/engine"
src-dirs: ../aircraft-design/libs/engine/src/
full-doc: true full-doc: true
doxy-cfg:
FILE_PATTERNS: "*.cpp *.h"
RECURSIVE: True
EXTRACT_ALL: YES
OUTPUT_DIRECTORY: "./docs/engine"
mission_analysis: mission_analysis:
doxyfile: Doxyfile src-dirs: aircraft-design/mission_analysis/src
variables:
PROJECT_NAME: "mission_analysis"
OUTPUT_DIR: "docs/api/mission_analysis"
BIBTEX_FILE: "docs/assets/bibtex/mission_analysis_literature.bib"
src-dirs: ../aircraft-design/mission_analysis/src/
full-doc: true full-doc: true
weight_and_balance_analysis: doxy-cfg:
doxyfile: Doxyfile FILE_PATTERNS: "*.cpp *.h"
variables: RECURSIVE: True
PROJECT_NAME: "weight_and_balance_analysis" EXTRACT_ALL: YES
OUTPUT_DIR: "docs/api/weight_and_balance_analysis" OUTPUT_DIRECTORY: "./docs/mission_analysis"
src-dirs: ../aircraft-design/weight_and_balance_analysis/src/ constraint_analysis:
full-doc: true src-dirs: aircraft-design/constraint_analysis/src
performance_assesment:
doxyfile: Doxyfile
variables:
PROJECT_NAME: "performance_assesment"
OUTPUT_DIR: "docs/api/performance_assesment"
src-dirs: ../aircraft-design/performance_assesment/src/
full-doc: true
cost_estimation:
doxyfile: Doxyfile
variables:
PROJECT_NAME: "cost_estimation"
OUTPUT_DIR: "docs/api/cost_estimation"
src-dirs: ../aircraft-design/cost_estimation/src/
full-doc: true full-doc: true
aircraft_geometry2: doxy-cfg:
doxyfile: Doxyfile FILE_PATTERNS: "*.cpp *.h"
variables: RECURSIVE: True
PROJECT_NAME: "aircraft_geometry2" EXTRACT_ALL: YES
OUTPUT_DIR: "docs/api/aircraft_geometry2" OUTPUT_DIRECTORY: "./docs/constraint_analysis"
src-dirs: ../aircraft-design/libs/aircraftGeometry2/src/ performance_assessment:
src-dirs: aircraft-design/performance_assessment/src
full-doc: true full-doc: true
engine: doxy-cfg:
doxyfile: Doxyfile FILE_PATTERNS: "*.cpp *.h"
variables: RECURSIVE: True
PROJECT_NAME: "engine" EXTRACT_ALL: YES
OUTPUT_DIR: "docs/api/engine" OUTPUT_DIRECTORY: "./docs/performance_assessment"
src-dirs: ../aircraft-design/libs/engine/src/ weight_and_balance_analysis:
src-dirs: aircraft-design/weight_and_balance_analysis/src
full-doc: true full-doc: true
doxy-cfg:
FILE_PATTERNS: "*.cpp *.h"
RECURSIVE: True
EXTRACT_ALL: YES
OUTPUT_DIRECTORY: "./docs/weight_and_balance_analysis"
- glightbox # Plugin for lightbox-style image and content viewing. - glightbox # Plugin for lightbox-style image and content viewing.
# === Theme configuration === # === Theme configuration ===
...@@ -274,13 +274,18 @@ nav: # Customizes the main navigation struc ...@@ -274,13 +274,18 @@ nav: # Customizes the main navigation struc
- Introduction: documentation/sizing/create_mission_xml/index.md - Introduction: documentation/sizing/create_mission_xml/index.md
- Getting Started: documentation/sizing/create_mission_xml/getting_started.md - Getting Started: documentation/sizing/create_mission_xml/getting_started.md
- Mission Steps: documentation/sizing/create_mission_xml/mission_steps.md - Mission Steps: documentation/sizing/create_mission_xml/mission_steps.md
- API Reference:
- create_mission_xml/classes.md
- create_mission_xml/namespaces.md
- create_mission_xml/files.md
- create_mission_xml/functions.md
- Fuselage Design: - Fuselage Design:
- Introduction: documentation/sizing/fuselage_design/index.md - Introduction: documentation/sizing/fuselage_design/index.md
- Getting Started: documentation/sizing/fuselage_design/getting_started.md - Getting Started: documentation/sizing/fuselage_design/getting_started.md
- Design Method: documentation/sizing/fuselage_design/design_method.md - Design Method: documentation/sizing/fuselage_design/design_method.md
- Run your First Design: documentation/sizing/fuselage_design/run_your_first_design.md - Run your First Design: documentation/sizing/fuselage_design/run_your_first_design.md
- Software Architecture: documentation/sizing/fuselage_design/software_architecture.md - Software Architecture: documentation/sizing/fuselage_design/software_architecture.md
# - API Reference: # TODO define for Python # # - API Reference: # TODO define for Python
- Wing Design: - Wing Design:
- Introduction: documentation/sizing/wing_design/index.md - Introduction: documentation/sizing/wing_design/index.md
- Getting Started: documentation/sizing/wing_design/getting-started.md - Getting Started: documentation/sizing/wing_design/getting-started.md
...@@ -312,7 +317,6 @@ nav: # Customizes the main navigation struc ...@@ -312,7 +317,6 @@ nav: # Customizes the main navigation struc
# - API Reference: # TODO define for Python # - API Reference: # TODO define for Python
- Propulsion Design: - Propulsion Design:
- Introduction: documentation/sizing/propulsion_design/index.md - Introduction: documentation/sizing/propulsion_design/index.md
- Overview: documentation/sizing/propulsion_design/overview.md
- Getting Started: documentation/sizing/propulsion_design/getting-started.md - Getting Started: documentation/sizing/propulsion_design/getting-started.md
- Engineering Principles: documentation/sizing/propulsion_design/engineering_principles.md - Engineering Principles: documentation/sizing/propulsion_design/engineering_principles.md
- Software Architecture: documentation/sizing/propulsion_design/software_architecture.md - Software Architecture: documentation/sizing/propulsion_design/software_architecture.md
...@@ -340,8 +344,8 @@ nav: # Customizes the main navigation struc ...@@ -340,8 +344,8 @@ nav: # Customizes the main navigation struc
- systems_design/namespaces.md - systems_design/namespaces.md
- systems_design/files.md - systems_design/files.md
- systems_design/functions.md - systems_design/functions.md
- Analysis: - Analysis:
- documentation/analysis/index.md # Link to analysis module page. - Modules: documentation/analysis.md # Link to analysis module page.
- Mission Analysis: - Mission Analysis:
- Introduction: documentation/analysis/mission_analysis/index.md - Introduction: documentation/analysis/mission_analysis/index.md
- Getting Started: documentation/analysis/mission_analysis/getting_started.md - Getting Started: documentation/analysis/mission_analysis/getting_started.md
...@@ -356,16 +360,7 @@ nav: # Customizes the main navigation struc ...@@ -356,16 +360,7 @@ nav: # Customizes the main navigation struc
- Introduction: documentation/analysis/weight_and_balance_analysis/index.md - Introduction: documentation/analysis/weight_and_balance_analysis/index.md
- Basic Concepts: documentation/analysis/weight_and_balance_analysis/basic-concepts.md - Basic Concepts: documentation/analysis/weight_and_balance_analysis/basic-concepts.md
- Usage: documentation/analysis/weight_and_balance_analysis/usage.md - Usage: documentation/analysis/weight_and_balance_analysis/usage.md
# - API Reference: # TODO define for Python # # - API Reference: # TODO define for Python
- Performance Assessment:
- Introduction: documentation/analysis/performance_assessment/index.md
- Getting Started: documentation/analysis/performance_assessment/getting_started.md
- Capabilities:
- Payload-Range Diagram: documentation/analysis/performance_assessment/payload_range_diagram.md
- Takeoff Performance: documentation/analysis/performance_assessment/takeoff_performance.md
- Landing Performance: documentation/analysis/performance_assessment/landing_performance.md
- Flight Envelope: documentation/analysis/performance_assessment/flight_envelope.md
- Ceiling Performance: documentation/analysis/performance_assessment/ceiling_performance.md
- Cost Estimation: - Cost Estimation:
- Introduction: documentation/analysis/cost_estimation/index.md - Introduction: documentation/analysis/cost_estimation/index.md
- Getting Started: documentation/analysis/cost_estimation/getting_started.md - Getting Started: documentation/analysis/cost_estimation/getting_started.md
...@@ -388,33 +383,38 @@ nav: # Customizes the main navigation struc ...@@ -388,33 +383,38 @@ nav: # Customizes the main navigation struc
- Introduction: documentation/analysis/aerodynamic_analysis/getting_started.md - Introduction: documentation/analysis/aerodynamic_analysis/getting_started.md
- Aerodynamic Principles: documentation/analysis/aerodynamic_analysis/aerodynamic_principles.md - Aerodynamic Principles: documentation/analysis/aerodynamic_analysis/aerodynamic_principles.md
- Software Architecture: documentation/analysis/aerodynamic_analysis/software_architecture.md - Software Architecture: documentation/analysis/aerodynamic_analysis/software_architecture.md
- API Reference:
- aerodynamic_analysis/classes.md
- aerodynamic_analysis/namespaces.md
- aerodynamic_analysis/files.md
- aerodynamic_analysis/functions.md
- Constraint Analysis: - Constraint Analysis:
- Introduction: documentation/analysis/constraint_analysis/index.md - Introduction: documentation/analysis/constraint_analysis/index.md
- Principles: documentation/analysis/constraint_analysis/principles.md - Principles: documentation/analysis/constraint_analysis/principles.md
- API Reference:
- constraint_analysis/classes.md
- constraint_analysis/namespaces.md
- constraint_analysis/files.md
- constraint_analysis/functions.md
- Performance Assessment:
- Introduction: documentation/analysis/performance_assessment/index.md
- Getting Started: documentation/analysis/performance_assessment/getting_started.md
- Mission Methods: documentation/analysis/performance_assessment/methods.md
- Mission Steps: documentation/analysis/performance_assessment/mission_steps.md
- API Reference:
- performance_assessment/classes.md
- performance_assessment/namespaces.md
- performance_assessment/files.md
- performance_assessment/functions.md
- Libraries: - Libraries:
- documentation/libraries/index.md # Link to libraries overview. - documentation/libraries/index.md # Link to libraries overview.
- AircraftGeometry2: - AircraftGeometry2:
- Introduction: documentation/libraries/aircraftGeometry2/index.md - Introduction: documentation/libraries/aircraftGeometry2/index.md
- Getting Started: documentation/libraries/aircraftGeometry2/getting-started.md - Getting Started: documentation/libraries/aircraftGeometry2/getting-started.md
- Tutorial: - Tutorial: documentation/libraries/aircraftGeometry2/tutorial.md
- Overview: documentation/libraries/aircraftGeometry2/tutorial.md
- Geometry: documentation/libraries/aircraftGeometry2/tutorial-geometry.md
- Factory: documentation/libraries/aircraftGeometry2/tutorial-factory.md
- Convert: documentation/libraries/aircraftGeometry2/tutorial-convert.md
- API Reference:
- aircraftGeometry2/classes.md
- aircraftGeometry2/namespaces.md
- aircraftGeometry2/files.md
- aircraftGeometry2/functions.md
- engine: - engine:
- Overview: - Introduction: documentation/libraries/engine/index.md
- documentation/libraries/engine/index.md - Utilities: documentation/additional_software.md
- API Reference:
- engine/classes.md
- engine/namespaces.md
- engine/files.md
- engine/functions.md
- Utilities: documentation/additional-software.md
- Workflow: 'workflow.md' # Link to the workflow page. - Workflow: 'workflow.md' # Link to the workflow page.
- Get Involved: - Get Involved:
- Developer Guide: get-involved/developer-installation.md # Top-level item for contributions and development. - Developer Guide: get-involved/developer-installation.md # Top-level item for contributions and development.
...@@ -455,4 +455,4 @@ nav: # Customizes the main navigation struc ...@@ -455,4 +455,4 @@ nav: # Customizes the main navigation struc
- About us: 'about.md' # Link to the about page. - About us: 'about.md' # Link to the about page.
- License: 'license.md' # Link to license information. - License: 'license.md' # Link to license information.
- Contact: 'contact.md' # Link to contact page. - Contact: 'contact.md' # Link to contact page.
- Partners: 'partners.md' # Link to partners page. - Partners: 'partners.md' # Link to partners page.
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment