Merge pull request #4973 from oleibman/readthedocs

Docs - Properdocs, Copy Clipboard, and Dark Mode Support

Author: oleibman

.readthedocs..mkdocs.yaml

@@ -0,0 +1,12 @@
+# Read the Docs configuration file for MkDocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html
+
+version: 2
+
+build:
+    os: ubuntu-22.04
+    tools:
+        python: "3"
+
+mkdocs:
+    configuration: mkdocs.mkdocs.yml

.readthedocs..readthedocs.yaml

@@ -0,0 +1,12 @@
+# Read the Docs configuration file for MkDocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html
+
+version: 2
+
+build:
+    os: ubuntu-22.04
+    tools:
+        python: "3"
+
+mkdocs:
+    configuration: mkdocs.readthedocs.yml

.readthedocs.material.yaml

@@ -0,0 +1,18 @@
+# Read the Docs configuration file for MkDocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html
+
+version: 2
+
+build:
+    os: ubuntu-24.04
+    tools:
+        python: "3"
+    # 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
+    jobs:
+        pre_install:
+            - pip install mkdocs-material
+
+mkdocs:
+    configuration: mkdocs.material.yml

.readthedocs.materialx.yaml

@@ -0,0 +1,18 @@
+# Read the Docs configuration file for MkDocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html
+
+version: 2
+
+build:
+    os: ubuntu-24.04
+    tools:
+        python: "3"
+    # 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
+    jobs:
+        pre_install:
+            - pip install mkdocs-materialx
+
+mkdocs:
+    configuration: mkdocs.materialx.yml

.readthedocs.properdocs.yaml

@@ -0,0 +1,14 @@
+# Read the Docs configuration file for MkDocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html
+
+version: 2
+
+build:
+    os: ubuntu-24.04
+    tools:
+        python: "3"
+    commands:
+        # 1. Install ProperDocs and any required themes/plugins
+        - pip install properdocs properdocs_theme_readthedocs properdocs_theme_mkdocs
+        # 2. Build the static site using the properdocs executable
+        - properdocs build --clean --site-dir $READTHEDOCS_OUTPUT/html

.readthedocs.yaml

@@ -4,9 +4,11 @@
 version: 2
 
 build:
-    os: ubuntu-22.04
+    os: ubuntu-24.04
     tools:
         python: "3"
-
-mkdocs:
-    configuration: mkdocs.yml
+    commands:
+        # 1. Install ProperDocs and any required themes/plugins
+        - pip install properdocs properdocs_theme_readthedocs properdocs_theme_mkdocs
+        # 2. Build the static site using the properdocs executable
+        - properdocs build --clean --site-dir $READTHEDOCS_OUTPUT/html

.readthedocs.zensical.yaml

@@ -0,0 +1,18 @@
+# Read the Docs configuration file for MkDocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html
+
+version: 2
+
+build:
+    os: ubuntu-24.04
+    tools:
+        python: "3"
+    jobs:
+        install:
+            - pip install zensical
+        build:
+            html:
+                - zensical build
+        post_build:
+            - mkdir -p $READTHEDOCS_OUTPUT/html/
+            - cp --recursive site/* $READTHEDOCS_OUTPUT/html/

CHANGELOG.md

@@ -23,6 +23,7 @@ Some earlier branches remain supported and security fixes are applied to them; i
 ### Changed
 
 - Performance: avoid `Worksheet::getStyle()` on every `Cell::setValueExplicit()` unless quote-prefix must change. On a dense 40k-cell populate+save microbenchmark this cut wall time by ~5%. [PR #4958](https://github.com/PHPOffice/PhpSpreadsheet/pull/4958)
+- Infrastructure changes for documentation. [PR #4973](https://github.com/PHPOffice/PhpSpreadsheet/pull/4973)
 
 ### Moved
 

docs/assets/logowithbackground.png

@@ -0,0 +1,23 @@
+/* Style the injected copy button inside code wrappers */
+
+.copy-code-button {
+    position: absolute;
+    top: 5px;
+    right: 5px;
+    padding: 4px 8px;
+    font-size: 12px;
+    color: #333;
+    background-color: #f0f0f0;
+    border: 1px solid #ccc;
+    border-radius: 3px;
+    cursor: pointer;
+    opacity: 0.7;
+    transition: opacity 0.2s ease-in-out;
+    z-index: 10;
+}
+
+.copy-code-button:hover {
+    opacity: 1;
+    background-color: #e0e0e0;
+}
+