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

1. [Step 1: checkout branch fix/delete_artifacts]
2. [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.

.gitlab-ci.yml

@@ -35,9 +35,7 @@ clone:
     - apk update && apk --no-cache add git doxygen graphviz ttf-freefont texmf-dist texmf-dist-latexextra texlive texlive-dvi
   script:
       # clone repos
-      - 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/
+      - git clone --recurse-submodules https://gitlab-ci-token:${CI_JOB_TOKEN}@git.rwth-aachen.de/unicado/aircraft-design
     # Change to the project directory (useful for multi-directory repositories)
       - cd $CI_PROJECT_DIR
       - ls -la $CI_PROJECT_DIR
@@ -47,6 +45,7 @@ clone:
       - $CI_PROJECT_DIR/aircraft-design
       - $CI_PROJECT_DIR/libraries
       - $CI_PROJECT_DIR/docs/documentation
+    expire_in: 5 Minutes
   rules:
     - 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
@@ -72,13 +71,20 @@ pages:
     - pipenv install --dev  # Install all necessary dependencies
   script:
     # Build the MkDocs documentation site
-    - pipenv run mkdocs build --verbose --site-dir $CI_PROJECT_DIR/public
+    - pipenv run mkdocs build --quiet --site-dir $CI_PROJECT_DIR/public
+    
+    # Delete .doxy directory if it exists
+    - if [ -d "$CI_PROJECT_DIR/public/assets/.doxy" ]; then rm -rf $CI_PROJECT_DIR/public/assets/.doxy; fi
+    # Delete all folders ending with _source in the public directory
+    - find $CI_PROJECT_DIR/public -type d -name '*_source' -exec rm -rf {} +
+
   needs:
     - clone  # This job depends on the successful completion of the clone job
   artifacts:
     # Save the generated static website files as artifacts
     paths:
       - $CI_PROJECT_DIR/public
+    expire_in: 5 Minutes #Artifacts will be stored for  5 Minutes
   rules:
     - 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