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

Install mkdoxy

parent be241125
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 #1563605 failed
...@@ -33,7 +33,7 @@ doxygen: ...@@ -33,7 +33,7 @@ doxygen:
# Clone the aircraft-design repository, including its submodules # Clone the aircraft-design repository, including its submodules
- 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 || { echo "Directory not found! Exiting..."; exit 1; }
- 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/libraries libs/
# Change to the project directory (useful for multi-directory repositories) # Change to the project directory (useful for multi-directory repositories)
- cd $CI_PROJECT_DIR - cd $CI_PROJECT_DIR
...@@ -60,6 +60,7 @@ pages: ...@@ -60,6 +60,7 @@ pages:
# Install pipenv to manage Python dependencies # Install pipenv to manage Python dependencies
- pip install pipenv - pip install pipenv
- pipenv install # Install the dependencies from the Pipfile - pipenv install # Install the dependencies from the Pipfile
- pipenv install mkdoxy # Install the mkdoxy plugin
script: script:
# Create the folder where the generated markdown files will be stored # Create the folder where the generated markdown files will be stored
- mkdir $CI_PROJECT_DIR/docs/aircraft-xml - mkdir $CI_PROJECT_DIR/docs/aircraft-xml
...@@ -68,8 +69,8 @@ pages: ...@@ -68,8 +69,8 @@ pages:
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title MassesAndLoadings --level 3 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/masses.md - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title MassesAndLoadings --level 3 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/masses.md
# Repeat for other titles (structure, propulsion, etc.) # Repeat for other titles (structure, propulsion, etc.)
- python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Geometry --level 6 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/geometry.md - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Geometry --level 6 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/geometry.md
# Add additional python scripts for other sections as necessary # Copy other documentation resources
- python scripts/copy_aircraft_design_to_docs.py # Copy other documentation resources - python $CI_PROJECT_DIR/scripts/copy_aircraft_design_to_docs.py
# Build the MkDocs documentation site # Build the MkDocs documentation site
- pipenv run mkdocs build --site-dir $CI_PROJECT_DIR/public - pipenv run mkdocs build --site-dir $CI_PROJECT_DIR/public
needs: needs:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment