Add git last updated sphinx extension

Shows when each page was last updated in the footer
wpilibsuite · Jan 24, 2025 · e87cdf8 · e87cdf8
1 parent f8a0b76
commit e87cdf8
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 6 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -10,6 +10,8 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
     - uses: actions/setup-python@v5
       with:
         python-version: 3.9
@@ -35,6 +37,8 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
     - uses: actions/setup-python@v5
       with:
         python-version: 3.9
@@ -68,6 +72,7 @@ jobs:
     - uses: actions/checkout@v4
       with:
         path: frc-docs
+        fetch-depth: 0
     - uses: actions/setup-python@v5
       with:
         python-version: 3.9

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -19,8 +19,9 @@ sphinx = "==7.4.7"
 sphinx_design= "==0.6.1"
 sphinx_copybutton = "==0.5.2"
 sphinx-hoverxref = "==1.4.0"
+sphinx-last-updated-by-git = "==0.3.8"
 sphinx-notfound-page = "==1.0.4"
-sphinx-rtd-theme = "==3.0.0"
+sphinx-rtd-theme = "==3.0.2"
 sphinx-tabs = "==3.4.5"
 sphinx-toolbox = "==3.8.0"
 modern-sphinx-version-warning = "==1.1.6"

diff --git a/readthedocs.yml b/readthedocs.yml
@@ -11,6 +11,9 @@ build:
     python: "3.9"
   apt_packages:
     - librsvg2-bin
+  jobs:
+    post_checkout:
+      - git fetch --unshallow || true
 
 formats:
   - htmlzip

diff --git a/source/conf.py b/source/conf.py
@@ -58,6 +58,7 @@
     "sphinx_toolbox.collapse",
     "sphinx_copybutton",
     "sphinx_contributors",
+    "sphinx_last_updated_by_git",
 ]
 
 local_extensions = [

diff --git a/source/requirements.txt b/source/requirements.txt
@@ -73,9 +73,10 @@ sphinx-copybutton==0.5.2 ; python_version >= "3.9" and python_version < "3.13"
 sphinx-design==0.6.1 ; python_version >= "3.9" and python_version < "3.13"
 sphinx-hoverxref==1.4.0 ; python_version >= "3.9" and python_version < "3.13"
 sphinx-jinja2-compat==0.3.0 ; python_version >= "3.9" and python_version < "3.13"
+sphinx-last-updated-by-git==0.3.8 ; python_version >= "3.9" and python_version < "3.13"
 sphinx-notfound-page==1.0.4 ; python_version >= "3.9" and python_version < "3.13"
 sphinx-prompt==1.8.0 ; python_version >= "3.9" and python_version < "3.13"
-sphinx-rtd-theme==3.0.0 ; python_version >= "3.9" and python_version < "3.13"
+sphinx-rtd-theme==3.0.2 ; python_version >= "3.9" and python_version < "3.13"
 sphinx-tabs==3.4.5 ; python_version >= "3.9" and python_version < "3.13"
 sphinx-toolbox==3.8.0 ; python_version >= "3.9" and python_version < "3.13"
 sphinx==7.4.7 ; python_version >= "3.9" and python_version < "3.13"