Move docs to zensical (#3852)

Author: EmilyxFox

.gitignore

@@ -4,3 +4,4 @@
 *.iml
 /gh-md-toc
 personal-build-and-develop.*
+site/

.readthedocs.yaml

@@ -1,14 +1,22 @@
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-version: 2
-
-build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.11"
-
-mkdocs:
-  configuration: mkdocs.yml
-
-python:
-  install:
-    - requirements: docs/requirements.txt
+version: 2
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: latest
+  jobs:
+    # We recommend using a requirements file for reproducible builds.
+    # This is just a quick example to get started.
+    # https://docs.readthedocs.io/page/guides/reproducible-builds.html
+    install:
+      - pip install zensical
+    build:
+      html:
+        - zensical build
+    post_build:
+      - mkdir -p $READTHEDOCS_OUTPUT/html/
+      - cp --recursive site/* $READTHEDOCS_OUTPUT/html/

compose-docs.yml

@@ -0,0 +1,16 @@
+# This composition can be used to serve up the rendered mkdocs for local authoring.
+#
+# docker compose -f compose-docs.yml -p zensical up
+#
+# and then access http://localhost:8000
+
+services:
+  zensical:
+    build:
+      context: .
+      dockerfile: docs/Dockerfile
+    volumes:
+      - ./zensical.toml:/docs/zensical.toml
+      - ./docs:/docs/docs
+    ports:
+      - "8000:8000"

docker-compose-mkdocs.yml

@@ -1,10 +1,4 @@
-FROM python:3.11
-
-RUN pip install --upgrade pip
-
-WORKDIR /mkdocs
+FROM zensical/zensical
 
 RUN --mount=target=/build/requirements.txt,source=docs/requirements.txt \
     pip install -r /build/requirements.txt
-
-ENTRYPOINT ["mkdocs"]

docs/Dockerfile

@@ -1,10 +1,25 @@
-mkdocs-material == 9.7.1
-mkdocs-autorefs == 1.4.3
-mkdocstrings[python] == 0.30.1
-mkdocs-literate-nav == 0.6.2
-mdx-gh-links == 0.4
-# need to pin for auto reload to work
-# see https://github.com/mkdocs/mkdocs/issues/4032
 click==8.3.1
-mkdocs-click == 0.9.0
-mkdocs-static-i18n == 1.3.0
+colorama==0.4.6
+deepmerge==2.0
+ghp-import==2.1.0
+griffe==1.15.0
+Jinja2==3.1.6
+Markdown==3.10
+MarkupSafe==3.0.3
+mergedeep==1.3.4
+mkdocs==1.6.1
+mkdocs-autorefs==1.4.3
+mkdocs-get-deps==0.2.0
+mkdocstrings==1.0.0
+mkdocstrings-python==2.0.1
+packaging==25.0
+pathspec==0.12.1
+platformdirs==4.5.1
+Pygments==2.19.2
+pymdown-extensions==10.19.1
+python-dateutil==2.9.0.post0
+PyYAML==6.0.3
+pyyaml_env_tag==1.1
+six==1.17.0
+watchdog==6.0.0
+# zensical @ file:///

docs/requirements.txt

@@ -0,0 +1,42 @@
+[project]
+site_name = "Minecraft Server on Docker (Java Edition)"
+site_url = "https://docker-minecraft-server.readthedocs.io/en/latest/"
+site_description = "Documentation for Minecraft Server on Docker"
+repo_name = "itzg/docker-minecraft-server"
+repo_url = "https://github.com/itzg/docker-minecraft-server"
+site_author = "itzg"
+copyright = "Copyright © itzg 2025."
+docs_dir = "docs"
+site_dir = "site"
+
+[project.theme]
+features = [
+    "navigation.tracking",
+    "navigation.tabs",
+    "navigation.tabs.sticky",
+    "navigation.sections",
+    "navigation.expand",
+    "navigation.top",
+    "navigation.indexes"
+]
+language = "en"
+
+[project.theme.icon]
+repo = "fontawesome/brands/github"
+
+[[project.theme.palette]]
+media = "(prefers-color-scheme)"
+toggle.icon = "lucide/sun-moon"
+toggle.name = "Switch to light mode"
+
+[[project.theme.palette]]
+media = "(prefers-color-scheme: light)"
+scheme = "default"
+toggle.icon = "lucide/sun"
+toggle.name = "Switch to dark mode"
+
+[[project.theme.palette]]
+media = "(prefers-color-scheme: dark)"
+scheme = "slate"
+toggle.icon = "lucide/moon"
+toggle.name = "Switch to light mode"