Skip to content

Commit

Permalink
Adding usage of git stamp to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
HarshithaPrabhuswamy committed Aug 30, 2024
1 parent 2946b6f commit 356702b
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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".
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 356702b

Please sign in to comment.