Add MKDocs

nationalarchives · Sep 4, 2024 · f56b134 · f56b134
1 parent eeb8657
commit f56b134
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -17,8 +17,8 @@ RUN tna-build
 RUN mkdir /app/app/static/assets; \
     cp -r /app/node_modules/@nationalarchives/frontend/nationalarchives/assets/* /app/app/static/assets
 
-# Delete source files and tests
-RUN rm -fR /app/src /app/test
+# Delete source files, tests and docs
+RUN rm -fR /app/src /app/test /app/docs
 
 # Run the application
 CMD ["tna-run", "flask_app:app"]
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -21,3 +21,10 @@ services:
     image: ghcr.io/nationalarchives/tna-python-dev:preview
     volumes:
       - ./:/app
+
+  docs:
+    image: squidfunk/mkdocs-material
+    volumes:
+      - .:/docs
+    ports:
+      - 1081:8000
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1 @@
+# Welcome
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,3 @@
+site_name: Flask Application Docs
+repo_url: https://github.com/nationalarchives/flask-application-template
+dev_addr: 0.0.0.0:1081