From b1b9a30daa720ddeb8a060eef7000478c0d5d4b1 Mon Sep 17 00:00:00 2001 From: Jan Frenzel <jan.frenzel@tu-dresden.de> Date: Wed, 20 Oct 2021 14:39:54 +0200 Subject: [PATCH] Removed copying of directories to container in Dockerfile. Removed requirements.txt. Removed a code snippet using requirements.txt from README.md. --- Dockerfile | 6 ++---- doc.zih.tu-dresden.de/README.md | 8 +------- doc.zih.tu-dresden.de/requirements.txt | 6 ------ 3 files changed, 3 insertions(+), 17 deletions(-) delete mode 100644 doc.zih.tu-dresden.de/requirements.txt diff --git a/Dockerfile b/Dockerfile index 731e831c9..f6bf98415 100644 --- a/Dockerfile +++ b/Dockerfile @@ -4,9 +4,7 @@ FROM python:3.8-bullseye # Base # ######## -COPY ./ /src/ - -RUN pip install -r /src/doc.zih.tu-dresden.de/requirements.txt +RUN pip install mkdocs>=1.1.2 mkdocs-material>=7.1.0 ########## # Linter # @@ -16,6 +14,6 @@ RUN apt update && apt install -y nodejs npm aspell RUN npm install -g markdownlint-cli markdown-link-check -WORKDIR /src/doc.zih.tu-dresden.de +WORKDIR /docs CMD ["mkdocs", "build", "--verbose", "--strict"] diff --git a/doc.zih.tu-dresden.de/README.md b/doc.zih.tu-dresden.de/README.md index e7de9cd2e..dc65e18d3 100644 --- a/doc.zih.tu-dresden.de/README.md +++ b/doc.zih.tu-dresden.de/README.md @@ -40,13 +40,7 @@ Now, create a local clone of your fork #### Install Dependencies -**TODO:** Description - -```Shell Session -~ cd hpc-compendium/doc.zih.tu-dresden.de -~ pip install -r requirements.txt -``` - +See [Installation with Docker](#preview-using-mkdocs-with-dockerfile). **TODO:** virtual environment **TODO:** What we need for markdownlinter and checks? diff --git a/doc.zih.tu-dresden.de/requirements.txt b/doc.zih.tu-dresden.de/requirements.txt deleted file mode 100644 index 272b09c7c..000000000 --- a/doc.zih.tu-dresden.de/requirements.txt +++ /dev/null @@ -1,6 +0,0 @@ -# Documentation static site generator & deployment tool -mkdocs>=1.1.2 - -# Add custom theme if not inside a theme_dir -# (https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes) -mkdocs-material>=7.1.0 -- GitLab