From f56b134e3a54e4a29e4feae3a3b103898ec89140 Mon Sep 17 00:00:00 2001 From: Andrew Hosgood Date: Wed, 4 Sep 2024 12:54:21 +0100 Subject: [PATCH] Add MKDocs --- Dockerfile | 4 ++-- docker-compose.yml | 7 +++++++ docs/index.md | 1 + mkdocs.yml | 3 +++ 4 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/Dockerfile b/Dockerfile index 64ebdb7..09a5579 100644 --- 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 index ace65bf..5388bf6 100644 --- 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 new file mode 100644 index 0000000..dd6974f --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +# Welcome \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..d338ca4 --- /dev/null +++ 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