mirror of
https://github.com/TeachBooks/template.git
synced 2026-11-12 22:25:52 +00:00
a567a11518
Updated comments in book/_toc.yml to indicate that certain configuration options are set to their default values and can be removed if desired. No functional changes to the table of contents structure.
47 lines
2.2 KiB
YAML
47 lines
2.2 KiB
YAML
# Configuration of _toc.yml file is explained in detail here: https://sphinx-external-toc.readthedocs.io/en/latest/user_guide/sphinx.html
|
|
|
|
format: jb-book
|
|
root: intro.md
|
|
|
|
parts:
|
|
- caption: Part with some content # A title for the whole the subtree, e.g. shown above the subtree in ToCs, configuration part of sphinx-external-toc (https://sphinx-external-toc.readthedocs.io/en/latest/intro.html)
|
|
numbered: false # Default value (line can be removed), whether to number the chapters/sections in this part, configuration part of sphinx-external-toc (https://sphinx-external-toc.readthedocs.io/en/latest/intro.html)
|
|
style: numerical # Default value (line can be removed), sstyle of numbering for this part, configuration part of TeachBooks' version of sphinx-external-toc (https://github.com/TeachBooks/sphinx-external-toc?tab=readme-ov-file#toc-tree-options)
|
|
restart_numbering: false # Default value (line can be removed), whether to restart numbering for this part, configuration part of TeachBooks' version of sphinx-external-toc (https://github.com/TeachBooks/sphinx-external-toc?tab=readme-ov-file#toc-tree-options)
|
|
chapters:
|
|
- file: some_content/overview.md
|
|
sections:
|
|
- file: some_content/text_and_code.ipynb
|
|
- caption: Exercises
|
|
chapters:
|
|
- file: exercises.md
|
|
sections:
|
|
- file: exercises/001.md
|
|
- file: exercises/002.md
|
|
- file: exercises/003.md
|
|
- file: exercises/004.md
|
|
- file: exercises/005.md
|
|
- file: exercises/005a.md
|
|
- file: exercises/006.md
|
|
- file: exercises/summary
|
|
- file: syntax_exercises.md
|
|
sections:
|
|
- file: syntax_exercises/007.md
|
|
- file: syntax_exercises/008.md
|
|
- file: syntax_exercises/009.md
|
|
- file: syntax_exercises/010.md
|
|
- file: syntax_exercises/011.md
|
|
- file: syntax_exercises/012.md
|
|
- file: syntax_exercises/013.md
|
|
- file: extensions.md
|
|
sections:
|
|
- file: exercises/007.md
|
|
- file: extension_exercises/017.md
|
|
- file: extension_exercises/014.md
|
|
- file: extension_exercises/015.md
|
|
- file: extension_exercises/016.md
|
|
- caption: Miscellaneous
|
|
chapters:
|
|
- file: references.md
|
|
- file: changelog.md
|
|
- file: credits.md
|