admin2/template
1
0
Fork 0
mirror of https://github.com/TeachBooks/template.git synced 2026-11-12 22:25:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update Sphinx configuration for git tracking options

Browse source
This commit is contained in:
Tom van Woudenberg 2026-01-07 16:18:33 +01:00 • committed by GitHub
parent 72040159f5
commit 63b2e17ae0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

8
book/_config.yml
View file

@ -89,9 +89,11 @@ 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_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_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/)
git_untracked_check_dependencies: false # Doesn't check date of dependencies if file is not tracked by git (yet), configuration part of Sphinx-Last-Updated-by-Git (https://github.com/TeachBooks/sphinx-last-updated-by-git)
git_untracked_show_sourcelink: true # Keeps sourcefiles in book when it is not tracked by git (yet), configuration part of Sphinx-Last-Updated-by-Git (https://github.com/TeachBooks/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/TeachBooks/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/TeachBooks/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/TeachBooks/sphinx-last-updated-by-git)
sphinx_gated_directives:
override_existing: true # Override existing gated directives with the same name, configuration part of Sphinx-GitHub-Alerts (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Gated-Directives/main/MANUAL.html)
nb_render_image_options: {} # Default value (line can be removed), options for image outputs, configuration part of Myst-NB (https://myst-nb.readthedocs.io/en/latest/configuration.html)