From ed929559560fccf7cda5b6d8910ed222b41f6e26 Mon Sep 17 00:00:00 2001
From: Kristina Mazur <kristina.mazur@tum.de>
Date: Wed, 5 Feb 2025 14:36:21 +0100
Subject: [PATCH] Change file directory and minor adaption in README
---
README.md | 2 +-
.../{style => modularization}/cpp-modularization.md | 0
.../{style => modularization}/python-modularization.md | 0
mkdocs.yml | 4 ++--
4 files changed, 3 insertions(+), 3 deletions(-)
rename docs/get-involved/{style => modularization}/cpp-modularization.md (100%)
rename docs/get-involved/{style => modularization}/python-modularization.md (100%)
diff --git a/README.md b/README.md
index ee00062..e284dc7 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ We are using `mkdocs` as the static site generator to generate the website from
You can preview the website after cloning it. First you need to install `mkdocs` and the used theme by:
```sh
-pip install mkdocs mkdocs-material mkdocs-glightbox mkdoxy
+pip install mkdocs mkdocs-material mkdocs-glightbox mkdoxy mkdocs-site-urls
```
Then you can change the directory to the repository and run
diff --git a/docs/get-involved/style/cpp-modularization.md b/docs/get-involved/modularization/cpp-modularization.md
similarity index 100%
rename from docs/get-involved/style/cpp-modularization.md
rename to docs/get-involved/modularization/cpp-modularization.md
diff --git a/docs/get-involved/style/python-modularization.md b/docs/get-involved/modularization/python-modularization.md
similarity index 100%
rename from docs/get-involved/style/python-modularization.md
rename to docs/get-involved/modularization/python-modularization.md
diff --git a/mkdocs.yml b/mkdocs.yml
index 791702a..5ecc4d5 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -337,8 +337,8 @@ nav: # Customizes the main navigation struc
- Include Libraries: get-involved/including-libraries.md
- CMake Presets: get-involved/cmake-presets.md
- Module Development:
- - Module Structure in c++: get-involved/style/cpp-modularization.md
- - Module Structure in Python: get-involved/style/python-modularization.md
+ - Module Structure in c++: get-involved/modularization/cpp-modularization.md
+ - Module Structure in Python: get-involved/modularization/python-modularization.md
- Style Guide:
- C++: get-involved/style/cpp.md
- Python: get-involved/style/python.md
--
GitLab