feat: add up to date mkdocs material in pyproject

for replacing the legacy mkdocs_plus image
GeoNet · May 6, 2024 · 918ecde · 918ecde
1 parent 1a60ee5
commit 918ecde
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -53,6 +53,7 @@ list of vendored base images
 | ghcr.io/geonet/base-images/hadolint/hadolint                    | a Dockerfile linter                                                            |
 | ghcr.io/geonet/base-images/hashicorp/terraform                  | Terraform image                                                                |
 | ghcr.io/geonet/base-images/mkdocs_plus                          | a custom build image for docs                                                  |
+| ghcr.io/geonet/base-images/mkdocs                               | a build of mkdocs material for docs                                            |
 | ghcr.io/geonet/base-images/nginx                                | minimal nginx image                                                            |
 | ghcr.io/geonet/base-images/node                                 | Alpine based node image                                                        |
 | ghcr.io/geonet/base-images/python                               | Alpine and Debian base Python images                                           |

diff --git a/config.yaml b/config.yaml
@@ -116,6 +116,8 @@ build:
   # - images are pushed to ghcr.io/geonet/base-images/IMAGE_NAME
   - source: ./images/mkdocs_plus/Dockerfile
     destination: ghcr.io/geonet/base-images/mkdocs_plus:latest
+  - source: ./images/mkdocs_material/Dockerfile
+    destination: ghcr.io/geonet/base-images/mkdocs:v1.6.0
   - source: ./images/git/image.yaml
     destination: ghcr.io/geonet/base-images/git:latest
   - source: ./images/git-ssh/image.yaml

diff --git a/images/mkdocs_material/Dockerfile b/images/mkdocs_material/Dockerfile
@@ -0,0 +1,6 @@
+FROM ghcr.io/geonet/base-images/debian:bullseye as builder
+RUN apt-get update
+RUN apt-get -y install python3-pip
+COPY pyproject.toml /src/docs/pyproject.toml
+RUN pip install '/src/docs'
+WORKDIR /src/docs
diff --git a/images/mkdocs_material/pyproject.toml b/images/mkdocs_material/pyproject.toml
@@ -0,0 +1,12 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta:__legacy__"
+
+[project]
+name = "platform-docs"
+dynamic = ["version"]
+dependencies = [
+    "mkdocs>=1.6.0",
+    "mkdocs-material>=9.5.19",
+    "mkdocs-awesome-pages-plugin>=2.9.2",
+]