From 6e12b87bb1655366bc459e9dafb1df18bbee6746 Mon Sep 17 00:00:00 2001 From: Tims777 Date: Wed, 14 Feb 2024 12:15:25 +0100 Subject: [PATCH] Fix includes of images from MD files Signed-off-by: Tims777 --- .gitignore | 1 + Documentation/Controller.md | 6 +++--- Documentation/Design-Documentation.md | 2 +- Documentation/Google-Search-Strategy.md | 2 +- .../{Media => _static}/BDC_Features.drawio | 0 .../{Media => _static}/BDC_Features.drawio.license | 0 .../component-diagram-with-controller.svg | 0 .../component-diagram-with-controller.svg.license | 0 .../{Media => _static}/component-diagram.svg | 0 .../component-diagram.svg.license | 0 .../controller-workflow-diagram.jpg | Bin .../controller-workflow-diagram.jpg.license | 0 .../google_places_strategy.drawio.png | Bin .../google_places_strategy.drawio.png.license | 0 .../{Media => _static}/sequence-diagram.svg | 0 .../{Media => _static}/sequence-diagram.svg.license | 0 src/docs/_static | 1 + 17 files changed, 7 insertions(+), 5 deletions(-) rename Documentation/{Media => _static}/BDC_Features.drawio (100%) rename Documentation/{Media => _static}/BDC_Features.drawio.license (100%) rename Documentation/{Media => _static}/component-diagram-with-controller.svg (100%) rename Documentation/{Media => _static}/component-diagram-with-controller.svg.license (100%) rename Documentation/{Media => _static}/component-diagram.svg (100%) rename Documentation/{Media => _static}/component-diagram.svg.license (100%) rename Documentation/{Media => _static}/controller-workflow-diagram.jpg (100%) rename Documentation/{Media => _static}/controller-workflow-diagram.jpg.license (100%) rename Documentation/{Media => _static}/google_places_strategy.drawio.png (100%) rename Documentation/{Media => _static}/google_places_strategy.drawio.png.license (100%) rename Documentation/{Media => _static}/sequence-diagram.svg (100%) rename Documentation/{Media => _static}/sequence-diagram.svg.license (100%) create mode 120000 src/docs/_static diff --git a/.gitignore b/.gitignore index da9ede4..a614236 100644 --- a/.gitignore +++ b/.gitignore @@ -64,6 +64,7 @@ bin/ !**/docs/Makefile !**/docs/readme_link.md !**/docs/documentation.rst +!**/docs/_static # Env files *.env diff --git a/Documentation/Controller.md b/Documentation/Controller.md index 09e46d0..b3125f6 100644 --- a/Documentation/Controller.md +++ b/Documentation/Controller.md @@ -21,12 +21,12 @@ Merchant Size Predictor is labelled as the (Estimated) Value Predictor here. ### Component Diagram -![Component Diagram](Media/component-diagram-with-controller.svg) +![Component Diagram](_static/component-diagram-with-controller.svg) ### Sequence Diagram -![Sequence Diagram](Media/sequence-diagram.svg) +![Sequence Diagram](_static/sequence-diagram.svg) ### Controller Workflow Diagram -![Controller Workflow Diagram](Media/controller-workflow-diagram.jpg) +![Controller Workflow Diagram](_static/controller-workflow-diagram.jpg) diff --git a/Documentation/Design-Documentation.md b/Documentation/Design-Documentation.md index d9a97f1..2c232fd 100644 --- a/Documentation/Design-Documentation.md +++ b/Documentation/Design-Documentation.md @@ -17,7 +17,7 @@ Merchant Size Predictor (MSP). ## Component Diagram -![Component Diagram](Media/component-diagram.svg) +![Component Diagram](_static/component-diagram.svg) ## External Software diff --git a/Documentation/Google-Search-Strategy.md b/Documentation/Google-Search-Strategy.md index 5b3a47c..4c35e3d 100644 --- a/Documentation/Google-Search-Strategy.md +++ b/Documentation/Google-Search-Strategy.md @@ -32,4 +32,4 @@ we try to combine the search methods and derive the most probable result. 4. Else: Return Phone-based search results 5. Else: Return nothing -![Search Strategy](./Media/google_places_strategy.drawio.png) +![Search Strategy](./_static/google_places_strategy.drawio.png) diff --git a/Documentation/Media/BDC_Features.drawio b/Documentation/_static/BDC_Features.drawio similarity index 100% rename from Documentation/Media/BDC_Features.drawio rename to Documentation/_static/BDC_Features.drawio diff --git a/Documentation/Media/BDC_Features.drawio.license b/Documentation/_static/BDC_Features.drawio.license similarity index 100% rename from Documentation/Media/BDC_Features.drawio.license rename to Documentation/_static/BDC_Features.drawio.license diff --git a/Documentation/Media/component-diagram-with-controller.svg b/Documentation/_static/component-diagram-with-controller.svg similarity index 100% rename from Documentation/Media/component-diagram-with-controller.svg rename to Documentation/_static/component-diagram-with-controller.svg diff --git a/Documentation/Media/component-diagram-with-controller.svg.license b/Documentation/_static/component-diagram-with-controller.svg.license similarity index 100% rename from Documentation/Media/component-diagram-with-controller.svg.license rename to Documentation/_static/component-diagram-with-controller.svg.license diff --git a/Documentation/Media/component-diagram.svg b/Documentation/_static/component-diagram.svg similarity index 100% rename from Documentation/Media/component-diagram.svg rename to Documentation/_static/component-diagram.svg diff --git a/Documentation/Media/component-diagram.svg.license b/Documentation/_static/component-diagram.svg.license similarity index 100% rename from Documentation/Media/component-diagram.svg.license rename to Documentation/_static/component-diagram.svg.license diff --git a/Documentation/Media/controller-workflow-diagram.jpg b/Documentation/_static/controller-workflow-diagram.jpg similarity index 100% rename from Documentation/Media/controller-workflow-diagram.jpg rename to Documentation/_static/controller-workflow-diagram.jpg diff --git a/Documentation/Media/controller-workflow-diagram.jpg.license b/Documentation/_static/controller-workflow-diagram.jpg.license similarity index 100% rename from Documentation/Media/controller-workflow-diagram.jpg.license rename to Documentation/_static/controller-workflow-diagram.jpg.license diff --git a/Documentation/Media/google_places_strategy.drawio.png b/Documentation/_static/google_places_strategy.drawio.png similarity index 100% rename from Documentation/Media/google_places_strategy.drawio.png rename to Documentation/_static/google_places_strategy.drawio.png diff --git a/Documentation/Media/google_places_strategy.drawio.png.license b/Documentation/_static/google_places_strategy.drawio.png.license similarity index 100% rename from Documentation/Media/google_places_strategy.drawio.png.license rename to Documentation/_static/google_places_strategy.drawio.png.license diff --git a/Documentation/Media/sequence-diagram.svg b/Documentation/_static/sequence-diagram.svg similarity index 100% rename from Documentation/Media/sequence-diagram.svg rename to Documentation/_static/sequence-diagram.svg diff --git a/Documentation/Media/sequence-diagram.svg.license b/Documentation/_static/sequence-diagram.svg.license similarity index 100% rename from Documentation/Media/sequence-diagram.svg.license rename to Documentation/_static/sequence-diagram.svg.license diff --git a/src/docs/_static b/src/docs/_static new file mode 120000 index 0000000..d66ddde --- /dev/null +++ b/src/docs/_static @@ -0,0 +1 @@ +../../Documentation/_static \ No newline at end of file