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

Merge pull request #95 from TeachBooks/Tom-van-Woudenberg-patch-1

Browse source 
Add metadata figure settings to config.yml
This commit is contained in:
Tom van Woudenberg 2025-12-01 09:14:03 +01:00 • committed by GitHub
commit ef57cc010f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 24 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

24
book/_config.yml
View file

@ -94,6 +94,30 @@ sphinx: # Options passed on to the
#tippy_custom_tips # Default value not shown (line can be removed), creates custom tips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html)
tippy_enable_mathjax: true # Default value (line can be removed), enables tooltips for math equations, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html)
#tippy_js # Default value not shown (line can be removed), sets the Javascript required to enable tooltips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html)
metadata_figure_settings: # Default values (lines can be removed), configuration options for Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
style:
placement: hide # Default value (line can be removed), hide the metadata, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
show: author,license,date,copyright,source # Default value (line can be removed), defines metadata to be shown if placement is not set to hide, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
admonition_title: Attribution # Default value (line can be removed), title of admonition if placement is set to admonition, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
admonition_class: attribution # Default value (line can be removed), CSS class of admonition if placement is set to admonition, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
license:
link_license: true # Default value (line can be removed), converts license to link, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
strict_check: false # Default value (line can be removed), doesn't raise an error when license infromation is missing or invalid, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
summaries: false # Default value (line can be removed), doesn't show a summary of invalid or missing licenses, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
individual: false # Default value (line can be removed), doesn't show individual warnings of invalid or missing licenses, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
substitute_missing: false # Default value (line can be removed), doesn't substitute missing license with default license, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
default_license: CC-BY # Default value (line can be removed), sets default license to CC BY, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
author:
substitute_missing: false # Default value (line can be removed), doesn't substitue missing author with default author, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
default_author: config # Default value (line can be removed), sets default author to author in config.yml, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
date:
substitute_missing: false # Default value (line can be removed), doesn't substitue missing date with default date, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
default_date: today # Default value (line can be removed), sets default data to date of build, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
copyright:
substitute_missing: false # Default value (line can be removed), doesn't substitue missing copyright with default copyright, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
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)
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)