[Ready] Add Sphinx extension to reflect a page's last update time + a…

…dd favicon (#3547) * First extension for last update date info Signed-off-by: Jo Stichbury <[email protected]> * Add favicon too Signed-off-by: Jo Stichbury <[email protected]> --------- Signed-off-by: Jo Stichbury <[email protected]>
kedro-org · Jan 31, 2024 · 3fe6e49 · 3fe6e49
1 parent 5de69e5
commit 3fe6e49
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -11,6 +11,8 @@ build:
     python: "3.9"
     nodejs: "19"
   jobs:
+    post_checkout:
+      - git fetch --unshallow || true
     pre_build:
       - pip freeze
       - python -m sphinx -WETan -j auto -D language=en -b linkcheck -d _build/doctrees docs/source _build/linkcheck

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -54,6 +54,8 @@
     "notfound.extension",
     "sphinxcontrib.jquery",
     "sphinx.ext.intersphinx",
+    "sphinx_last_updated_by_git",
+    "sphinx_favicon",
     "sphinxcontrib.youtube",
 ]
 
@@ -79,13 +81,18 @@
 # The master toctree document.
 master_doc = "index"
 
+favicons = [
+    "https://kedro.org/images/favicon.ico",
+]
+
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
 language = "en"
 
+
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path .

diff --git a/pyproject.toml b/pyproject.toml
@@ -98,6 +98,8 @@ docs = [
     "ipykernel>=5.3, <7.0",
     "myst-parser>=1.0,<2.1",
     "Jinja2<3.2.0",
+    "sphinx-last-updated-by-git",
+    "sphinx-favicon",
     "sphinxcontrib-youtube",
 ]
 all = [ "kedro[test,docs]" ]