Add a "last updated at" timestamp in doc pages

GitHub: mxcube#899
fabcor-maxiv · Jun 14, 2024 · f2bcee1 · f2bcee1
1 parent 0600d5a
commit f2bcee1
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 3 deletions.
diff --git a/.readthedocs.yaml b/.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-dev.yml --force"
     - "mamba run --name mxcubecore poetry install --only=docs,main"
     - "mamba run --name mxcubecore sphinx-build -T -E -b html -c ./docs/ ./docs/source/ ${READTHEDOCS_OUTPUT}/html/"

diff --git a/docs/conf.py b/docs/conf.py
@@ -10,7 +10,6 @@
 import datetime
 import importlib.metadata
 
-
 PROJECT_PACKAGE_NAME = "mxcubecore"
 PROJECT_PACKAGE_METADATA = importlib.metadata.metadata(PROJECT_PACKAGE_NAME)
 
@@ -103,4 +102,10 @@
 myst_enable_extensions = ("fieldlist",)
 
 
+# -- Options for sphinx_last_updated_by_git
+# https://pypi.org/project/sphinx-last-updated-by-git/
+
+extensions.append("sphinx_last_updated_by_git")
+
+
 # EOF
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -58,9 +58,10 @@ pytest-cov = "^4.0.0"
 pytest-mock = "^3.10.0"
 
 [tool.poetry.group.docs.dependencies]
+furo = "^2023.9.10"
 myst-parser = "^2.0.0"
 sphinx = "<7.2"
-furo = "^2023.9.10"
+sphinx-last-updated-by-git = "^0.3.7"
 
 [tool.poetry.extras]
 tango = ["PyTango"]