mirror of
https://github.com/TeachBooks/manual.git
synced 2026-11-13 06:45:52 +00:00
627f2f28b5
Moved basic features into a new 'Original Jupyter Book and Sphinx Features' section, consolidated and reordered feature sections, and updated references to external documentation. This improves the logical organization and clarity of the table of contents.
142 lines
5.4 KiB
YAML
142 lines
5.4 KiB
YAML
format: jb-book
|
|
root: intro
|
|
|
|
parts:
|
|
- caption: Your First TeachBook!
|
|
chapters:
|
|
- file: intro/book.md
|
|
- file: intro/workflow.md
|
|
- file: intro/template.md
|
|
- file: intro/next.md
|
|
- caption: Getting Going!
|
|
chapters:
|
|
- file: installation-and-setup/user_types.md
|
|
- file: installation-and-setup/git.md
|
|
sections:
|
|
- file: installation-and-setup/tools
|
|
- file: installation-and-setup/overview.md
|
|
sections:
|
|
- file: installation-and-setup/vscode-setup.md
|
|
- file: installation-and-setup/git-setup_local.md
|
|
- file: installation-and-setup/anaconda.md
|
|
- file: installation-and-setup/git_bash_conda_vs-code.md
|
|
- file: installation-and-setup/jupyter-book-setup.md
|
|
- file: workflows/collaboration.md
|
|
sections:
|
|
- file: workflows/milestones_issues.md
|
|
- file: workflows/branches.md
|
|
- file: workflows/edit_book.md
|
|
- file: workflows/check_changes_online.md
|
|
- file: workflows/merge_request.md
|
|
- file: installation-and-setup/collab
|
|
- file: installation-and-setup/versioning
|
|
sections:
|
|
- file: installation-and-setup/versions_URLs
|
|
- file: installation-and-setup/versioning_changelog
|
|
- file: installation-and-setup/publisher
|
|
- file: installation-and-setup/copyright.md
|
|
sections:
|
|
- file: installation-and-setup/copyright/considerations
|
|
- file: installation-and-setup/copyright/licenses
|
|
- file: installation-and-setup/copyright/recommendations
|
|
- caption: Features
|
|
chapters:
|
|
- file: features/overview.md
|
|
sections:
|
|
- file: features/teachbooks_intro.md
|
|
- file: external/deploy-book-workflow/README.md
|
|
- file: features/favourites.md
|
|
- file: features/easy-editing.md
|
|
sections:
|
|
- file: external/template/README.md
|
|
- file: features/draft-release
|
|
- file: features/pull_request_build.md
|
|
- file: features/local_server
|
|
- file: features/external_toc
|
|
sections:
|
|
- file: external/Nested-Books/README.md
|
|
title: (Deprecated) Share content between books using submodules
|
|
- file: features/update_env
|
|
- file: features/versioning
|
|
- file: features/sphinx_extensions.md
|
|
sections:
|
|
- file: external/Download-Link-Replacer/README.md
|
|
- file: external/Sphinx-launch-buttons/README.md
|
|
- file: basic-features/utterances.md
|
|
- file: features/h5p.md
|
|
sections:
|
|
- file: examples/h5p_examples.md
|
|
- file: features/plotly.ipynb
|
|
- file: external/Sphinx-Grasple-public/README.md
|
|
- file: features/HTML_javascript.md
|
|
sections:
|
|
- file: features/adding_HTML_elements.md
|
|
- file: features/creating_basic_HTML_elements.md
|
|
- file: features/live_code
|
|
sections:
|
|
- file: features/widgets.ipynb
|
|
- file: features/exercise_checking.ipynb
|
|
- file: features/jupyterquiz.ipynb
|
|
- file: external/sphinx-iframes/README.md
|
|
- external: https://github.com/TeachBooks/Sphinx-Indexed-Definitions/blob/manual/README.md
|
|
- file: external/Sphinx-PRIME-applets/README.md
|
|
- external: https://github.com/TeachBooks/Sphinx-Dropdown-Toggle/blob/main/MANUAL.md
|
|
- external: "https://github.com/TeachBooks/sphinx-code-examples/blob/main/MANUAL.ipynb"
|
|
- external: "https://github.com/TeachBooks/Sphinx-NB-Execution-Patterns/blob/Manual/README.md"
|
|
- file: features/visuals.md
|
|
sections:
|
|
- external: https://github.com/TeachBooks/Sphinx-Accessibility/blob/manual/README.md
|
|
- file: external/Sphinx-Image-Inverter/README.md
|
|
- file: external/JupyterBook-Patches/README.md
|
|
- file: external/Sphinx-TUDelft-theme/README.md
|
|
- file: external/teachbooks-sphinx-tippy/README.md
|
|
- file: features/apa
|
|
- file: external/Sphinx-Named-Colors/README.md
|
|
- external: https://github.com/TeachBooks/Sphinx-ref-graph/blob/manual/README.md #BUMP
|
|
- file: features/students
|
|
sections:
|
|
- file: external/annotater/README.md
|
|
- file: basic-features/hypothesis.md
|
|
- caption: Original Jupyter Book and Sphinx Features
|
|
chapters:
|
|
- file: basic-features/overview.md
|
|
sections:
|
|
- file: basic-features/jupyterbook.md
|
|
- file: basic-features/figures.md
|
|
- file: basic-features/equations.md
|
|
- file: basic-features/videos.md
|
|
- file: basic-features/References.md
|
|
- file: basic-features/code.md
|
|
- file: basic-features/Code_block_figures
|
|
- file: basic-features/badges.md
|
|
- file: basic-features/banner
|
|
title: Banner or Announcement
|
|
- caption: Examples
|
|
chapters:
|
|
- file: examples/overview.md
|
|
sections:
|
|
- file: examples/book_structure.md
|
|
- file: examples/live_code.md
|
|
- file: examples/example_gumbel.ipynb
|
|
- file: examples/theory_questions.md
|
|
- file: examples/example_quiz_interactive.ipynb
|
|
- file: examples/coding_theory_widgets.ipynb
|
|
- file: examples/parametric_questions.ipynb
|
|
|
|
- caption: Editing Tools
|
|
chapters:
|
|
- file: tools/figmaker
|
|
- file: helper_code/intro.md
|
|
sections:
|
|
- file: helper_code/converter.md
|
|
- file: helper_code/move_images.md
|
|
- file: external/Useful_python_code/snippit.ipynb
|
|
- file: external/Useful_python_code/extensionfildownloadreturn.ipynb
|
|
- file: external/Useful_python_code/figshrinker.ipynb
|
|
|
|
- caption: Miscellaneous
|
|
chapters:
|
|
- file: references.md
|
|
- file: credits
|
|
- file: changelog
|
|
- file: contact
|