mirror of
https://github.com/TeachBooks/manual.git
synced 2026-11-13 23:05:51 +00:00
30 lines
No EOL
2 KiB
Markdown
30 lines
No EOL
2 KiB
Markdown
````{margin}
|
|
```{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](../external/template/README.md) and can be installed independently using `pip install teachbooks-favourites`. The features included are:
|
|
|
|
- [Sphinx-Thebe from TeachBooks](./live_code.ipynb)
|
|
- [Jupyterbook patches](../external/jupyterbook-patches/README.md)
|
|
- [Download link replacer](../external/download-link-replacer/README.md)
|
|
- [Sphinx image inverter](../external/sphinx-image-inverter/README.md)
|
|
- [Sphinx iframes](../external/sphinx-iframes/README.md)
|
|
- [Sphinx exercise (TeachBooks contribution to the original)](https://ebp-sphinx-exercise.readthedocs.io/en/latest/)
|
|
- [Teachbooks Sphinx tippy](../external/teachbooks-sphinx-tippy/README.html)
|
|
- [Sphinx named colors](../external/sphinx-named-colors/README.md)
|
|
- [Sphinx dropdown toggle](../_git/github.com_TeachBooks_Sphinx-Dropdown-Toggle/main/MANUAL.md)
|
|
- [Sphinx proof (TeachBooks contribution to the original)](https://sphinx-proof.readthedocs.io/en/latest/)
|
|
- [Sphinx code examples](../_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.md)
|
|
- [Sphinx accessibility](../_git/github.com_TeachBooks_Sphinx-Accessibility/manual/README.html)
|
|
- [Sphinx toggle button (TeachBooks contribution to the original)](https://sphinx-togglebutton.readthedocs.io/en/latest/)
|
|
- [Notebook execution patterns](../_git/github.com_TeachBooks_Sphinx-NB-Execution-Patterns/Manual/README.html)
|
|
|
|
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. |