From 356702bf9af550ca452fd59aa6c5c57097da0ef6 Mon Sep 17 00:00:00 2001 From: Harshitha Prabhuswamy Date: Fri, 30 Aug 2024 12:03:11 +0200 Subject: [PATCH] Adding usage of git stamp to documentation --- docs/conf.py | 6 ++++++ setup.py | 1 + 2 files changed, 7 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 6590cf2f..c585cb6c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -59,6 +59,8 @@ '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', # Add usage of git stamp to documentation ] # Add any paths that contain templates here, relative to this directory. @@ -90,6 +92,10 @@ html_theme = "sphinx_rtd_theme" +# -- Options for html date format for the last updated information------------------------------------------------- + +html_last_updated_fmt = "%b %d, %Y" + # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". diff --git a/setup.py b/setup.py index 245d6576..93e1bbc6 100644 --- a/setup.py +++ b/setup.py @@ -62,6 +62,7 @@ 'nbsphinx', # use Jupyter Notebooks in the documentation 'ipython', # for setting up the pygments_lexer 'ipykernel', # for allowing nbsphinx to execute the Jupyter Notebooks + 'sphinx-last-updated-by-git', # add information about latest modification of a file # checking code quality 'pylint', # lint Python code