mirror of
https://github.com/TeachBooks/manual.git
synced 2026-11-13 14:55:51 +00:00
76ab30859c
Split the TeachBooks Python Package and Deploy Book Workflow documentation into dedicated intro pages (teachbooks_intro.md, DBW_intro.md), update references and links throughout feature pages, and revise the _toc.yml structure to include new sections. Added clarifications to favourites and live_code features, improving organization and navigation for users.
2 KiB
2 KiB
```{admonition} User types
:class: tip
This page is useful for user type 3-5.
```
{bdg-primary}`Sphinx Extension`
```
TeachBooks Favourites
TeachBooks Favourites is a Sphinx extension which collects all of TeachBooks' favourite features in one place (including tools originally by TeachBooks and from other sources). It is included by default in the TeachBooks Template and can be installed independently using pip install teachbooks-favourites. The features included are:
- Sphinx-Thebe from TeachBooks
- Jupyterbook patches
- Download link replacer
- Sphinx image inverter
- Sphinx iframes
- Sphinx exercise (TeachBooks contribution to the original)
- Teachbooks Sphinx tippy
- Sphinx named colors
- Sphinx dropdown toggle
- Sphinx proof (TeachBooks contribution to the original)
- Sphinx code examples
- Sphinx accessibility
- Sphinx toggle button (TeachBooks contribution to the original)
- Notebook execution patterns
All features which are part of TeachBooks Favourites are indicated with {bdg-primary-line}Part of TeachBooks Favourites. If you'd like to use specific features, but not the entire TeachBooks Favourites, you can remove this extension and replace it with the individual extensions you want to use.