Add a "last updated at" timestamp in doc pages

GitHub: related to mxcube/mxcubecore#899

.github/workflows/pages.yaml

@@ -34,6 +34,10 @@ jobs:
 
       - name: "Checkout"
         uses: "actions/checkout@v4"  # tested with v4.0.0
+        with:
+          # With shallow clone the "Last updated" timestamp can not get computed
+          # See "Caveats" at https://pypi.org/project/sphinx-last-updated-by-git
+          fetch-depth: 0
 
       # Use micromamba instead of conda for better performance
       - name: "Setup conda environment with micromamba"

.readthedocs.yaml

@@ -20,6 +20,9 @@ build:
     python: "mambaforge-22.9"
 
   commands:
+    # With shallow clone the "Last updated" timestamps can not get computed
+    # See "Caveats" at <https://pypi.org/project/sphinx-last-updated-by-git/>
+    - "git fetch --unshallow || true"
     - "mamba env create --file conda-environment.yml --force"
     - "mamba run --name mxcubeweb poetry install --only=docs,main"
     - "(mamba run --name mxcubeweb redis-server &) && mamba run --name mxcubeweb python -m sphinx -T -E -b html -d _build/doctrees -c docs docs/source ${READTHEDOCS_OUTPUT}/html && mamba run --name mxcubeweb redis-cli shutdown"

docs/conf.py

@@ -6,7 +6,6 @@
 
 import mxcubeweb
 
-
 MXCUBE_NAME = "MXCuBE"
 MXCUBE_CORE_NAME = f"{MXCUBE_NAME}-Web"
 MXCUBE_WEB_NAME = f"{MXCUBE_NAME}-Web"
@@ -122,4 +121,10 @@
 extensions.append("sphinxcontrib.autohttp.flask")
 
 
+# -- Options for sphinx_last_updated_by_git
+# https://pypi.org/project/sphinx-last-updated-by-git/
+
+extensions.append("sphinx_last_updated_by_git")
+
+
 # EOF

pyproject.toml

@@ -49,10 +49,11 @@ pytest = "7.1.3"
 pytest-cov = "4.0.0"
 
 [tool.poetry.group.docs.dependencies]
+furo = "^2023.9.10"
 myst-parser = "^2.0.0"
 sphinx = "<7.2"
+sphinx-last-updated-by-git = "^0.3.7"
 sphinxcontrib-httpdomain = "^1.8.1"
-furo = "^2023.9.10"
 
 [tool.black]
 line-length = 88