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

Continued opinionated list of config options

Browse source
This commit is contained in:
Tom van Woudenberg 2026-01-05 11:41:54 +01:00 • committed by GitHub
parent 6d3d875820
commit f8b7864162
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

26
book/_config.yml
View file

@ -52,7 +52,7 @@ sphinx: # Options passed on to the
iframe_aspectratio: auto 2 / 1 # Default value (line can be removed), sets the standard aspect ration of the iframe within the parent element, configuration part of Sphinx-Iframes (https://teachbooks.io/manual/external/sphinx-iframes/README.html)
hide_solutions: false # Default value (line can be removed), does not hide all solutions from exercises, configuration part of Sphinx-Exercise (https://ebp-sphinx-exercise.readthedocs.io/en/latest/syntax.html#remove-all-solutions)
exercise_style: "" # Default value (line can be removed), does not simplify solution titles (simplified are useful when solutions directly follow exercises), configuration part of Sphinx-Exercise (https://ebp-sphinx-exercise.readthedocs.io/en/latest/syntax.html#solution-title-styling)
named_colors_custom_colors: null # Default value (line can be removed), defines no custom named colours (include no colour for attribution admonition of external pages), configuration part of Sphinx-Named-Colors (https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html)
named_colors_custom_colors: {'attributiongrey':[150,150,150]} # Defines grey colour for attribution boxes, configuration part of Sphinx-Named-Colors (https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html)
proof_minimal_theme: false # Default value (line can be removed), uses default color scheme for admonitions part of sphinx-proof, configuration part of Sphinx-Proof (https://sphinx-proof.readthedocs.io/en/latest/options.html)
sphinx_codex_name: "" # Default value (line can be removed), uses default 'Code example' as title for codex directives, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html)
sphinx_codex_style_from_proof: true # Default value (line can be removed), the CSS color style of the codex directive will be taken from the prf:example directive from the sphinx-proof extension, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html)
@ -89,23 +89,21 @@ 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)
sphinx_gated_directives:
suffix_start: start # Default value (line can be removed), suffix for the start directive, configuration part of Sphinx-GitHub-Alerts (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Gated-Directives/main/MANUAL.html)
suffix_end: end # Default value (line can be removed), suffix for the end directive, configuration part of Sphinx-GitHub-Alerts (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Gated-Directives/main/MANUAL.html)
suffix_separator: '-' # Default value (line can be removed), separator between the original directive name and the suffix, configuration part of Sphinx-GitHub-Alerts (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Gated-Directives/main/MANUAL.html)
override_existing: false # Default value (line can be removed), whether to 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)
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)
nb_render_figure_options: {} # Default value (line can be removed), options for figure outputs, configuration part of Myst-NB (https://myst-nb.readthedocs.io/en/latest/configuration.html)
nb_scroll_outputs: false # Default value (line can be removed), make long cell outputs not scrollable, configuration part of Myst-NB (https://myst-nb.readthedocs.io/en/latest/configuration.html)
nb_remove_code_source: false # Default value (line can be removed), do not remove code cell source, configuration part of Myst-NB (https://myst-nb.readthedocs.io/en/latest/configuration.html)
nb_remove_code_outputs: false # Default value (line can be removed), do not remove code cell outputs, configuration part of Myst-NB (https://myst-nb.readthedocs.io/en/latest/configuration.html)
teachbooks:
attribution_location: top # Default value (line can be removed), sets location of attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html)
attribution_color: null # Default value (line can be removed), uses blue colour for attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html)
attribution_color: attributiongrey # Uses custom grey colour for attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html)
bibtex_bibfiles:
- references.bib # Required for references, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html)
@ -119,4 +117,8 @@ parse:
- substitution
- tasklist
myst_url_schemes: [mailto, http, https] # Default value (lines can be removed), sets URI schemes that will be recognised as external URLs in Markdown links, configuration part of MyST parser (https://myst-parser.readthedocs.io/en/latest/syntax/optional.html)
myst_dmath_double_inline: true # Default value (lines can be removed), allows display math ($$) within an inline context, configuration part of MyST parser (https://myst-parser.readthedocs.io/en/latest/syntax/optional.html)
myst_links_external_new_tab: true # Opens all eternal links in a new tab, configuration part of MyST parser (https://myst-parser.readthedocs.io/en/latest/configuration.html)
myst_number_code_blocks: [] # Default value (lines can be removed), add line numbers to code blocks with these languages, configuration part of MyST parser (https://myst-parser.readthedocs.io/en/latest/configuration.html)
myst_substitutions: {} # Default value (lines can be removed), sets no substitutions, configuration part of https://myst-parser.readthedocs.io/en/latest/configuration.html
myst_dmath_double_inline: true # Parse inline `$$ ... $$`, configuration part of https://myst-parser.readthedocs.io/en/latest/configuration.html
myst_enable_checkboxes: false # Default value (lines can be removed), disables checkboxes, configuration part of https://myst-parser.readthedocs.io/en/latest/configuration.html