diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 8cc32bd066..607a5fdfc8 100644 --- 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 + - "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 index 8ff037bcdf..691a0c223d 100644 --- 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 index 7c318845ab..3e2edff9fb 100644 --- a/poetry.lock +++ b/poetry.lock @@ -2208,6 +2208,20 @@ sphinx = ">=4.0" [package.extras] docs = ["furo", "ipython", "myst-parser", "sphinx-copybutton", "sphinx-inline-tabs"] +[[package]] +name = "sphinx-last-updated-by-git" +version = "0.3.7" +description = "Get the \"last updated\" time for each Sphinx page from Git" +optional = false +python-versions = ">=3.7" +files = [ + {file = "sphinx_last_updated_by_git-0.3.7-py3-none-any.whl", hash = "sha256:9937f235911aaec566a652b26952b29f530abb86f98e0fb67843227301636457"}, + {file = "sphinx_last_updated_by_git-0.3.7.tar.gz", hash = "sha256:edfd4970d9778123d3d0d9c5c9a9e3d700867a080539eb2bfe01e7078ca1dc78"}, +] + +[package.dependencies] +sphinx = ">=1.8" + [[package]] name = "sphinxcontrib-applehelp" version = "1.0.4" @@ -2547,4 +2561,4 @@ tango = ["PyTango"] [metadata] lock-version = "2.0" python-versions = ">=3.8,<3.11" -content-hash = "643ee355bfd753eb799ccf37f899043c2ce90e73805fc7373a207e867d384076" +content-hash = "067aba2ba09ae4acef333b31b15ca53601a4d8597290c03b7fb13812e4ce7cf8" diff --git a/pyproject.toml b/pyproject.toml index 746fef0adb..9aa9f23017 100644 --- 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"]