Shallow docs setup with MKDocs #1686

Author: dennissiemensma

.readthedocs.yaml

@@ -10,13 +10,9 @@ build:
   tools:
     python: "3.12"
 
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-  configuration: docs/conf.py
-
 # Build documentation with MkDocs
-#mkdocs:
-#  configuration: mkdocs.yml
+mkdocs:
+  configuration: mkdocs.yml
 
 python:
   install:

documentation/docs/index.md

@@ -0,0 +1 @@
+# DSMR-reader documentation

wiki/reference/API.md documentation/docs/reference/API.md

@@ -5,13 +5,13 @@ The application has an API, allowing you to insert/create readings and retrieve
 ## Configuration
 You can access the API-documentation by selecting the **Support** menu item in DSMR-reader.
 
-![Support](/wiki/static/screenshots/api/support.png)
+![Screenshot](/static/screenshots/api/support.png)
 
 
 ### Enable API
 The API is disabled by default in the application. You may enable it in the **Configuration**.
 
-![API settings](/wiki/static/screenshots/api/api-settings.png)
+![Screenshot](/static/screenshots/api/api-settings.png)
 
 
 ## API key

wiki/static/screenshots/api/api-settings.png documentation/docs/static/screenshots/api/api-settings.png

@@ -0,0 +1,10 @@
+site_name: DSMR-reader Documentation
+site_url: https://github.com/dsmrreader/dsmr-reader
+site_description: DSMR-reader
+site_author: Dennis Siemensma
+copyright: Dennis Siemensma
+theme: readthedocs
+locale: en
+markdown_extensions:
+  - toc:
+      baselevel: 2

wiki/static/screenshots/api/support.png documentation/docs/static/screenshots/api/support.png

@@ -0,0 +1 @@
+mkdocs==1.6

documentation/mkdocs.yml

@@ -25,19 +25,11 @@ ENV POETRY_VIRTUALENVS_IN_PROJECT=true
 RUN pip install poetry
 COPY ./src/ /app/
 RUN poetry install --with dev --no-root
-EXPOSE 8000
 ENTRYPOINT ["poetry", "run"]
 
 
 FROM local-dsmrreader-base AS local-dsmrreader-docs
-WORKDIR /app-docs
-COPY ./docs/requirements.txt /app-docs/
-RUN pip install -r requirements.txt
-
-FROM local-dsmrreader-docs AS local-dsmrreader-docs-en
-EXPOSE 10000
-ENTRYPOINT sphinx-autobuild . /var/tmp/_build/html --host 0.0.0.0 --port 10000 -D language=en
-
-FROM local-dsmrreader-docs AS local-dsmrreader-docs-nl
-EXPOSE 10000
-ENTRYPOINT sphinx-autobuild . /var/tmp/_build/html --host 0.0.0.0 --port 10000 -D language=nl
+WORKDIR /app
+COPY ./documentation/ /app/
+RUN pip install -r /app/requirements.txt
+ENTRYPOINT ["mkdocs"]

documentation/requirements.txt

@@ -47,31 +47,19 @@ services:
       - ~/Desktop:/run/host/Desktop/
 
   # http://localhost:10000
-  dsmr-docs-en:
-    container_name: dsmr-docs-en
-    restart: 'unless-stopped'
+  dsmr-docs:
+    container_name: dsmr-docs
+    restart: 'on-failure'
+    command: 'serve --dev-addr 0.0.0.0:10000'
     build:
       context: .
       dockerfile: provisioning/container/Containerfile-dev
-      target: local-dsmrreader-docs-en
+      target: local-dsmrreader-docs
     volumes:
-      - ./docs:/app-docs
+      - ./documentation:/app
     ports:
       - '10000:10000'
 
-  # http://localhost:10001
-  dsmr-docs-nl:
-    container_name: dsmr-docs-nl
-    restart: 'unless-stopped'
-    build:
-      context: .
-      dockerfile: provisioning/container/Containerfile-dev
-      target: local-dsmrreader-docs-nl
-    volumes:
-      - ./docs:/app-docs
-    ports:
-      - '10001:10000'
-
   mosquitto:
     container_name: mosquitto-dev
     image: eclipse-mosquitto:2