TeachBooks Favourites

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 or can be installed independently. The features included are:

The extension Open in new tab is nice, but is not compatible with all setups (dependency clash) so is not included in TeachBooks-Favourites.

All features which are part of TeachBooks Favourites are include the following label on their respective pages in this manual: 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.

Installation#

To install TeachBooks-Favourites, follow these steps:

Step 1: Install the Package

Install the teachbooks-favourites package using pip:

pip install git+https://github.com/TeachBooks/TeachBooks-Favourites

Step 2: Add to requirements.txt

Make sure that the package is included in your project’s requirements.txt to track the dependency:

git+https://github.com/TeachBooks/TeachBooks-Favourites

Step 3: Enable in _config.yml

In your _config.yml file, add the extension to the list of Sphinx extra extensions (important: underscore, not dash this time):

sphinx: 
    extra_extensions:
        - teachbooks_favourites

Usage#

For using the various package we refer to the different manuals linked above.

All extensions are loaded with their default settings.

Contribute#

Do you think we missed an extension that should really be included? Let us know by either

  • creating a fork of this repository and submitting a pull request, in which you added the extension to the files

    • README.md

    • pyproject.toml

    • src\teachbooks_favourites\__init__.py

  • opening an issue.

Contents