mirror of
https://github.com/TeachBooks/manual.git
synced 2026-11-13 14:55:51 +00:00
Refactor the sphinx_gated_directives extension to support configurable suffixes and separator for start/end directives, and add an 'override_existing' option for more flexible directive registration. Update the registry naming and logic throughout the extension, add configuration validation, and update the book config and intro to demonstrate new exercise directives and nesting.
66 lines
2.4 KiB
YAML
66 lines
2.4 KiB
YAML
title: TeachBooks Manual
|
|
author: TeachBooks Development Team and TeachBooks users, built with <a href="https://teachbooks.io/">TeachBooks</a>, <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="license noopener noreferrer"">CC BY 4.0<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg" alt=""></a>
|
|
|
|
execute:
|
|
execute_notebooks: 'auto'
|
|
|
|
only_build_toc_files: true
|
|
|
|
html:
|
|
favicon : "images/favicon.ico"
|
|
baseurl : "https://teachbooks.io/manual/"
|
|
|
|
sphinx:
|
|
local_extensions:
|
|
sphinx_gated_directives: _ext
|
|
extra_extensions:
|
|
- sphinx_inline_tabs
|
|
- sphinx.ext.imgconverter
|
|
- teachbooks_favourites
|
|
- teachbooks_sphinx_grasple
|
|
- sphinx_apa_references
|
|
- sphinx_tudelft_theme
|
|
config:
|
|
sphinx_gated_directives:
|
|
override_existing: ['exercise']
|
|
language: en
|
|
html_js_files:
|
|
- https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js
|
|
thebe_config:
|
|
use_thebe_lite: true
|
|
exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb","**/*.gif","**/*.txt","**/*.json",]
|
|
html_theme_options:
|
|
logo:
|
|
text: Manual
|
|
image_light: TeachBooks_logo.svg
|
|
image_dark: TeachBooks_logo_inverted.svg
|
|
repository_url: "https://github.com/TeachBooks/manual/"
|
|
path_to_docs: "book"
|
|
repository_branch: "release"
|
|
use_repository_button: true
|
|
use_edit_page_button: true
|
|
use_issues_button : true
|
|
launch_buttons:
|
|
thebe: true
|
|
html_show_copyright: false
|
|
html_last_updated_fmt: '%B %-d, %Y'
|
|
html_static_path: ["images"]
|
|
mathjax3_config:
|
|
tex:
|
|
macros:
|
|
"newcolor": ['\definecolor{newcolor}{RGB}{111, 29, 119}{\color{newcolor}#1}',1]
|
|
named_colors_custom_colors: {'onlylight':[165,21,160],'lightanddark':[45,180,117,204,158,110],'hyphen-color':[45,180,117,165,21,160],'attributiongrey':[150,150,150]}
|
|
metadata_figure_settings:
|
|
style:
|
|
placement: hide
|
|
license:
|
|
summaries: false
|
|
individual: false
|
|
nb_execution_includepatterns: "**/MANUAL.ipynb"
|
|
|
|
teachbooks:
|
|
attribution_location: margin
|
|
attribution_color: attributiongrey
|
|
|
|
bibtex_bibfiles:
|
|
- references.bib
|