JupyterBook-Patches

JupyterBook-Patches#

This page reuses BSD 3-Clause License content from TeachBooks (2024). Find out more here.

User types

This section is useful for user type 4-5.

Sphinx Extension

This Sphinx extension fixes:

  • an issue where drop down menus would still take up space after being minimized, and the patch fixes it through some css.

  • an issue where in drop down code cells the shown summary remained lightgray instead of turning darkgrey. Fix through css.

Installation#

To install the Sphinx-JupyterBook-Patches, follow these steps:

Step 1: Install the Package

Install the jupyterbook_patches package using pip:

pip install jupyterbook_patches

Step 2: Add to requirements.txt

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

jupyterbook_patches

Step 3: Enable in _config.yml

In your _config.yml file, add the extension to the list of Sphinx extra extensions:

sphinx: 
    extra_extensions:
        - jupyterbook_patches

Contribute#

This tool’s repository is stored on GitHub. The README.md of the branch manual_docs is also part of the TeachBooks manual as a submodule. If you’d like to contribute, you can create a fork and open a pull request on the GitHub repository. To update the README.md shown in the TeachBooks manual, create a fork and open a merge request for the GitHub repository of the manual. If you intent to clone the manual including its submodules, clone using: git clone --recurse-submodulesgit@github.com:TeachBooks/manual.git.

Contents