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.

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.3.0.tar.gz (6.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.3.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: jupyterbook_patches-1.3.0.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for jupyterbook_patches-1.3.0.tar.gz
Algorithm Hash digest
SHA256 e5a7c076b76653822ffbe6ebd7d84fa093469dd8755d90d41644be94949f539e
MD5 4ed201fbb09b2bcabb73b36bc05eac13
BLAKE2b-256 1d8d694c713fc210abc7f88c923225a77d5955da70b701ed7fc25f7dbdf2f779

See more details on using hashes here.

Provenance

The following attestation bundles were made for jupyterbook_patches-1.3.0.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.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterbook_patches-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a372604986d70423b2d0a260ce0ba5ba6c33a440dcd43319d14fa3967b018841
MD5 dca321e8d30651950cfd45842e42fa54
BLAKE2b-256 db41dbfc01c1e344bec3aac76466c75edfd98e19794cc41fad6a7d3561949d74

See more details on using hashes here.

Provenance

The following attestation bundles were made for jupyterbook_patches-1.3.0-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