Merge pull request #5657 from squidfunk/revert-5626-user-req

Revert "Add support for user-provided python packages"
squidfunk · Jun 29, 2023 · 6c66437 · 6c66437
2 parents ea8d302 + 03fe01d
commit 6c66437
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 13 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -34,7 +34,7 @@ WORKDIR /tmp
 COPY material material
 COPY package.json package.json
 COPY README.md README.md
-COPY *requirements.txt ./
+COPY requirements.txt requirements.txt
 COPY pyproject.toml pyproject.toml
 
 # Perform build and cleanup artifacts and caches
@@ -66,8 +66,6 @@ RUN \
       "pillow>=9.0" \
       "cairosvg>=2.5"; \
   fi \
-&& \
-  [ -e user-requirements.txt ] && pip install -U -r user-requirements.txt \
 && \
   apk del .build \
 && \

diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -117,12 +117,11 @@ The following plugins are bundled with the Docker image:
 
     Material for MkDocs only bundles selected plugins in order to keep the size
     of the official image small. If the plugin you want to use is not included, 
-    create a `user-requirements.txt` file in the repository root with the packages
-    you want to install additionally, e.g.:
+    create a new `Dockerfile` and extend the official Docker image:
 
-    ``` txt title="user-requirements.txt"
-    mkdocs-macros-plugin==0.7.0
-    mkdocs-glightbox>=0.3.1
+    ``` Dockerfile
+    FROM squidfunk/mkdocs-material
+    RUN pip install ...
     ```
 
     Next, you can build the image with the following command:
@@ -131,8 +130,7 @@ The following plugins are bundled with the Docker image:
     docker build -t squidfunk/mkdocs-material .
     ```
 
-    The new image will have additional packages installed and can be used
-    exactly like the official image.
+    The new image can be used exactly like the official image.
 
 ### with git
 

diff --git a/docs/insiders/getting-started.md b/docs/insiders/getting-started.md
@@ -79,9 +79,6 @@ docker login -u ${GH_USERNAME} -p ${GHCR_TOKEN} ghcr.io
 docker pull ghcr.io/${GH_USERNAME}/mkdocs-material-insiders
 ```
 
-Should you wish to add additional plugins to the insiders container image, follow the steps
-outlined in the [Getting Started guide](../getting-started.md#with-docker).
-
   [^2]:
     Earlier, Insiders provided a dedicated Docker image which was available to
     all sponsors. On March 21, 2021, the image was deprecated for the reasons