Add MKDocs

nationalarchives · Sep 4, 2024 · ccefe5f · ccefe5f
1 parent 5112245
commit ccefe5f
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 0 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -15,5 +15,8 @@ RUN tna-build
 # Copy in the application code
 COPY --chown=app . .
 
+# Delete tests and docs
+RUN rm -fR /app/test /app/docs
+
 # Run the application
 CMD ["tna-run", "-a", "fastapi_app:app"]
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -17,3 +17,10 @@ services:
     image: ghcr.io/nationalarchives/tna-python-dev:preview
     volumes:
       - ./:/app
+
+  docs:
+    image: squidfunk/mkdocs-material
+    volumes:
+      - .:/docs
+    ports:
+      - 1083: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