Updates mkdocs configuration and adds pipenv.

.gitlab-ci.yml

@@ -46,7 +46,7 @@ pages:
   tags:
     - documentation
   before_script:
-    - pip install mkdocs-material mkdocs-glightbox
+    - pip install pipenv
   script:
     - mkdir $CI_PROJECT_DIR/docs/aircraft-xml
     - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title General --level 1 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/general.md
@@ -63,12 +63,12 @@ pages:
     - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title EcologicalValues --level 4 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/ecological.md
     - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title Requirements --level 3 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/requirements.md
     - python $CI_PROJECT_DIR/scripts/document_aircraft_xml.py --title DesignSpecification --level 4 $CI_PROJECT_DIR/scripts/CSR-02.xml > $CI_PROJECT_DIR/docs/aircraft-xml/specification.md
-    - mkdocs build --site-dir public
+    - pipenv run mkdocs build --site-dir $CI_PROJECT_DIR/public
   needs:
     - doxygen
   artifacts:
     paths:
-      - public
+      - $CI_PROJECT_DIR/public
   rules:
     - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
       when: on_success

Pipfile

+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+mkdocs = "*"
+mkdocs-material = "*"
+mkdocs-glightbox = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.11"

README.md

@@ -17,6 +17,12 @@ mkdocs serve
 
 This will start a local webserver which you can access with your webbrowser and preview the website.
 
+### with pipenv
+You can also start the server inside a virtual environment using `pipenv`:
+```sh 
+pipenv run mkdocs serve
+```
+
 ## Further Documentation
 For features of the site generator and its theme please refer to their excellent documentation:
 

mkdocs.yml

@@ -27,8 +27,8 @@ markdown_extensions:
   - pymdownx.tabbed:
       alternate_style: true
   - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.highlight:
       anchor_linenums: true
       line_spans: __span