Merge pull request #96 from TeachBooks/add_git_date

Add git date options
This commit is contained in:
Tom van Woudenberg 2025-12-17 13:17:10 +01:00 • committed by GitHub
commit ec7366fa0a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -43,7 +43,7 @@ sphinx: # Options passed on to the
thebe: true # Required for live code, part of TeachBooks-Sphinx-Thebe (https://teachbooks.io/manual/features/live_code.html)
announcement: "" # Default value (line can be removed), sets a banner announcement at the top of the site, configuration part of Jupyterbook v1 (https://jupyterbook.org/en/stable/customize/config.html)
html_show_copyright: false # As the copyright is included in the author field, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html)
html_last_updated_fmt: '%B %-d, %Y' # Adds the date of the last update to the footer, use '%-d %B %Y' for a Dutch formatting of the date, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html)
html_last_updated_fmt: '' # Adds the date of the last update to the footer, if '' based on value of language
html_static_path: ["figures"] # Add folder that contain files that need to be included, such as the location of the logo(s), configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html)
mathjax3_config:
chtml: {
@ -118,6 +118,12 @@ sphinx: # Options passed on to the
default_copyright: authoryear # Default value (line can be removed), sets default copyright to author and year, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
source:
warn_missing: false # Default value (line can be removed), doesn't raise a warning for missing sources, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
git_untracked_check_dependencies: true # Default value (line can be removed), allow checking dependencies for last updated date of untracked files, configuration part of Sphinx-Last-Updated-by-Git (https://github.com/mgeier/sphinx-last-updated-by-git/)
git_untracked_show_sourcelink: false # Default value (line can be removed), doesn't show source link for untracked files, configuration part of Sphinx-Last-Updated-by-Git (https://github.com/mgeier/sphinx-last-updated-by-git/)
git_last_updated_timezone: 'Europe/Amsterdam' # Sets local timezone for last updated date, otherwise uses local time zone of build, configuration part of Sphinx-Last-Updated-by-Git (https://github.com/mgeier/sphinx-last-updated-by-git/)
git_last_updated_metatags: true # Default value (line can be removed), adds meta tags with git last updated information to the HTML head, configuration part of Sphinx-Last-Updated-by-Git (https://github.com/mgeier/sphinx-last-updated-by-git/)
git_exclude_patterns: [] # Default value (line can be removed), sets a list of patterns to *skip* in git last updated date checking, configuration part of Sphinx-Last-Updated-by-Git (https://github.com/mgeier/sphinx-last-updated-by-git/)
git_exclude_commits: [] # Default value (line can be removed), sets a list of commit hashes to *skip* in git last updated date checking, configuration part of Sphinx-Last-Updated-by-Git (https://github.com/mgeier/sphinx-last-updated-by-git/)
sphinx_github_alerts_backquotes: 3 # Default value (line can be removed), sets the number of backticks used to start and end the admonitions, configuration part of Sphinx-GitHub-Alerts (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-GitHub-Alerts/main/README.html)
sphinx_github_alerts_redirects: {} # Default value (line can be removed), no redirects are set, configuration part of Sphinx-GitHub-Alerts (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-GitHub-Alerts/main/README.html)