Add git stamp to display the last update timestamp in the documentation. (#219)

Author: HarshithaPrabhuswamy

.github/workflows/docs.yaml

@@ -29,6 +29,11 @@ jobs:
         sudo apt-get update && sudo apt-get upgrade && sudo apt-get install pandoc
 
     - uses: actions/checkout@v3
+
+    jobs:
+      post_checkout:
+        - git fetch --unshallow || true
+        
     - run: |
         curl -LJO "https://media.tuhh.de/mls/software/conflowgen/docs/data/prepared_dbs/demo_poc.sqlite"
         curl -LJO "https://media.tuhh.de/mls/software/conflowgen/docs/data/prepared_dbs/demo_deham_cta.sqlite"

docs/conf.py

@@ -59,6 +59,7 @@
     'enum_tools.autoenum',  # automatically document enums
     'sphinx_toolbox.more_autodoc.autonamedtuple',  # automatically document namedtuples
     'nbsphinx',  # use Jupyter notebooks to add programmatically created visuals
+    'sphinx_last_updated_by_git', # Extension to display the last update timestamp and author in the documentation
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -219,3 +220,4 @@
         os.system(f'echo \'mv "{database_name}.sqlite" "{sqlite_databases_directory}"\'')
         os.system(f'mv "{database_name}.sqlite" "{sqlite_databases_directory}"')
     os.system("echo 'sqlite databases fetched'")
+

setup.py

@@ -75,7 +75,9 @@
             'twine',  # check and upload package to PyPI
 
             # pip resolution issue - https://github.com/pypa/pip/issues/12430#issuecomment-1849059000
-            'sphinx-tabs'
+            'sphinx-tabs',
+
+            'sphinx-last-updated-by-git'
         ],
         # a collection of nice-to-haves for working on Jupyter Notebooks - just a favorites list of the authors
         'jupyterlab': [