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

Clarify default values in _toc.yml comments

Browse source 
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.
This commit is contained in:
Tom van Woudenberg 2025-10-20 16:39:10 +02:00
parent 0527e30da4
commit a567a11518
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
book/_toc.yml
View file

@ -5,9 +5,9 @@ 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 # 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 # Style 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 # 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)
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: