mirror of
https://github.com/TeachBooks/manual.git
synced 2026-11-12 22:35:51 +00:00
new structure
This commit is contained in:
parent
e292c741e9
commit
eaf27aae20
6 changed files with 26 additions and 17 deletions
|
|
@ -26,7 +26,7 @@ parts:
|
|||
- file: installation-and-setup/creating_content.md
|
||||
- caption: Features
|
||||
chapters:
|
||||
- file: basic-features/overview
|
||||
- file: basic-features/overview.md
|
||||
sections:
|
||||
- file: basic-features/jupyterbook.md
|
||||
- file: basic-features/figures.md
|
||||
|
|
@ -37,6 +37,8 @@ parts:
|
|||
- file: basic-features/Code_block_figures
|
||||
- file: basic-features/banner
|
||||
title: Banner or Announcement
|
||||
- file: basic-features/external-features.md
|
||||
sections:
|
||||
- file: basic-features/hypothesis.md
|
||||
- file: basic-features/utterances.md
|
||||
- file: features/overview.md
|
||||
|
|
@ -44,14 +46,10 @@ parts:
|
|||
- file: external/TeachBooks/README.md
|
||||
- file: external/deploy-book-workflow/README.md
|
||||
- file: external/Nested-Books/README.md
|
||||
- file: features/sphinx_extensions.md
|
||||
sections:
|
||||
- file: external/Download-Link-Replacer/README.md
|
||||
- file: external/Sphinx-Image-Inverter/README.md
|
||||
- file: features/custom-launch-button.md
|
||||
- file: external/JupyterBook-Patches/README.md
|
||||
- file: external/Sphinx-TUDelft-theme/README.md
|
||||
- file: external/teachbooks-sphinx-tippy/README.md
|
||||
- file: features/sphinx_extensions.md
|
||||
sections:
|
||||
- file: external/Download-Link-Replacer/README.md
|
||||
- file: features/custom-launch-button.md
|
||||
- file: features/interactive_element.ipynb
|
||||
sections:
|
||||
- file: external/Sphinx-Grasple-public/README.md
|
||||
|
|
@ -64,6 +62,12 @@ parts:
|
|||
sections:
|
||||
- file: features/widgets.ipynb
|
||||
- file: features/exercise_checking.ipynb
|
||||
- file: features/visuals.md
|
||||
sections:
|
||||
- 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/students
|
||||
sections:
|
||||
- file: external/annotater/README.md
|
||||
|
|
|
|||
1
book/basic-features/external-features.md
Normal file
1
book/basic-features/external-features.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# Externally developed features
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
# Original Jupyter Book Features
|
||||
# Jupyter Book/Sphinx Features
|
||||
|
||||
```{admonition} User types
|
||||
:class: tip
|
||||
This section is useful for [user type 3-5](../installation-and-setup/user_types.md).
|
||||
```
|
||||
|
||||
These pages will provide a list of some common, basic book features which are all available in the original <a href="https://jupyterbook.org/"><img style="display:inline-block; height:1.5em; width:auto; transform:translate(0, -0.15em)" src="../images/logo-wide.svg" alt="Jupyter book"></a> package. However, this page includes also best-practices.
|
||||
These pages will provide a list of some common, basic book features which are all available in the original <a href="https://jupyterbook.org/"><img style="display:inline-block; height:1.5em; width:auto; transform:translate(0, -0.15em)" src="../images/logo-wide.svg" alt="Jupyter book"></a> package. Additionally, this page includes also best-practices.
|
||||
|
|
|
|||
0
book/features/easy-editing.md
Normal file
0
book/features/easy-editing.md
Normal file
|
|
@ -1,12 +1,15 @@
|
|||
# TeachBooks Authoring Features
|
||||
# Easy editing process
|
||||
|
||||
As TeachBooks, we collect a suite of existing open-source software and keep our books up-to-date so you don't have to! Some of the software is developed with our TA's to improve the learning experience of our students and ease the book-development process for our teachers. By deploying these tools from a central location we can prevent common problems before they arise, and fix them quickly when they do occur. As the open-source software landscape changes rapidly, it is essential to keep in contact and share resources amongst ourselves to minimize maintenance and downtime for our book websites and focus on what really matters: teaching!
|
||||
|
||||
This chapter provides a list of commonly used book features together with sub-pages that provide additional information on:
|
||||
- the purpose
|
||||
- how to install them
|
||||
- how to use them
|
||||
- where to find the source code
|
||||
Since the list of TeachBook features is getting quite long, we have grouped them in categories:
|
||||
- Easy Editing Process
|
||||
- Additional Book Functionalities
|
||||
- Book Visuals
|
||||
|
||||
Additionally, not all features are built using the same type of sourcecode. For transparency, tags will help differentiate between the different backgrounds of the features.
|
||||
|
||||
Finally, the purpose, installation process and usage of each features is elaborated on in the respective sub-sections.
|
||||
|
||||
To see examples for these features, go to the [Examples chapter](../examples/overview.md).
|
||||
|
||||
|
|
|
|||
1
book/visuals.md
Normal file
1
book/visuals.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# hi
|
||||
Loading…
Add table
Add a link
Reference in a new issue