Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding usage of git stamp to documentation #214

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adding usage of git stamp to documentation #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/conf.py
View file
Open in desktop
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
View file
Open in desktop
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
Loading