Fix/missing_API_documentation
Fix missing api documentation in website
Description
Issue : Artifact size in public folder exceeds the limit of 500MB and hence deployment fails.
Solution1 : Try to reduce artifact size by generating only necessary files. Solution2: Try to compress and deploy the artifacts
Related Issue(s)
Other Changes
- [Mention refactoring, tests, etc.]
Screenshots/Logs
Attach screenshots or log outputs if applicable.
Testing Instructions
- [Step 1: checkout branch fix/delete_artifacts]
- [Step 2: run mkdocs build and mkdocs serve , verify API refernces are now displayed correctly for all tools except python tools]
Note: Make sure you have manually copied aircraft_design repository and libraies to aircraft_design.Commands given below for reference.
- git clone https://gitlab-ci-token:${CI_JOB_TOKEN}@git.rwth-aachen.de/unicado/aircraft-design
- cd aircraft-design
- git clone --recurse-submodules https://gitlab-ci-token:${CI_JOB_TOKEN}@git.rwth-aachen.de/unicado/libraries libs/
You can also verify this directly through the CI pipeline by triggering a new pipeline from the latest commit of this merge request. Then, check the UNICADO website to confirm whether the API documentation is displayed correctly as a result of the commit.
Developer Checklist
-
Code has been tested locally and/or in pipeline. -
(if applicable) documentation updated. -
(if applicable) impact of new dependencies reviewed and included in project. -
Merge conflicts resolved with the target branch.
Additional Notes
Add any information reviewers should focus on, e.g., specific files, functions, or changes of interest.