Skip to main content

A collection of useful Jupyter Book patches.

Project description

Sphinx extension: JupyterBook-Patches

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.
  • an issue where the size of code in a header is not the correct font size. Fix through css.
  • an issue where two buttons for interactive matplotlib widget do not appear.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterbook_patches-1.4.2.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jupyterbook_patches-1.4.2-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

Details for the file jupyterbook_patches-1.4.2.tar.gz.

File metadata

  • Download URL: jupyterbook_patches-1.4.2.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for jupyterbook_patches-1.4.2.tar.gz
Algorithm Hash digest
SHA256 a6b1f2a57fe4a7b6399686e42e5fea731f6fead0e0acf0962603f9462001d47d
MD5 a01c5f3228493d0474f77d4072c75985
BLAKE2b-256 a3e62c3e78f03e5ff0ad7f642b4f6ebef2609e28e955dc8637c96d71f2e16db1

See more details on using hashes here.

Provenance

The following attestation bundles were made for jupyterbook_patches-1.4.2.tar.gz:

Publisher: python-publish.yml on TeachBooks/JupyterBook-Patches

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file jupyterbook_patches-1.4.2-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterbook_patches-1.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a9e3ddf5e9f6e85ab5e0180d3dbdada34054e80503530d9f00eee93b1beaff6d
MD5 0adb2180ed52b284f44a65d4995c088a
BLAKE2b-256 3c7be6a26ed8d2a242749e1d91103064f51293471b013949254944cc827436a4

See more details on using hashes here.

Provenance

The following attestation bundles were made for jupyterbook_patches-1.4.2-py3-none-any.whl:

Publisher: python-publish.yml on TeachBooks/JupyterBook-Patches

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page