jupyterbook-patches

https://github.com/teachbooks/jupyterbook-patches

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
✓
DOI references
Found 3 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (10.1%) to scientific vocabulary

Last synced: 6 months ago · JSON representation ·

Repository

Basic Info

Host: GitHub
Owner: TeachBooks
License: other
Language: Python
Default Branch: main
Size: 79.1 KB

Statistics

Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Releases: 14

Created over 1 year ago · Last pushed 7 months ago

Metadata Files

Readme License Citation Codeowners

Sphinx extension: JupyterBook-Patches

This Sphinx extension fixes: - with a layout patch: - 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 the sidebar shows a scrollbar even if that's not needed - an issue where the margin causes a scroll bar for a window between 992 and 1200px. - an issue where the caption text of a figure is aligned on the left for multi-line caption text - with a button patch: - an issue where two buttons for interactive matplotlib widget do not appear. - with a mathjax patch: - an issue where in the Firefox browser the CHTML renderer of MathJax does not render thin lines consistently. Fixed by selecting the SVG renderer only for the Firefox browser.

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

Step 4 (optional): Disable patches in _config.yml

In your _config.yml file, add disable patches you do not wish: sphinx: config: patch_config: disabled-patches: []

Replace [] by a list of strings to disable patches. Use the patch name as indicated at the top of this document.

For example, to disable the mathjax patch:

sphinx: config: patch_config: disabled-patches: ["mathjax"]

For example, to disable the layout and button patches:

sphinx: config: patch_config: disabled-patches: ["button","layout"]

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.

Owner

Name: PSOR Books
Login: TeachBooks
Kind: organization
Email: books-CEG@tudelft.nl
Location: Netherlands

Repositories: 1
Profile: https://github.com/TeachBooks

Teachers’ Educational Assistance for interaCtive Hands-on Browser-based Online Open Knowledge for Students

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - email: info@teachbooks.io
    name: 'TeachBooks Development Team'
    website: 'https://teachbooks.io/'
title: "JupyterBook-Patches"
version: 1.4.3
date-released: 2025-03-28
repository-code: 'https://github.com/TeachBooks/JupyterBook-Patches'
url: >-
  https://teachbooks.io/manual/external/JupyterBook-Patches/README.html
identifiers:
  - type: doi
    value: 10.5281/zenodo.15101012
    description: Zenodo record
  - type: url
    value: https://pypi.org/project/jupyterbook-patches/
    description: 'PyPi publication'
license: BSD-3-Clause

GitHub Events

Total

Release event: 15
Delete event: 9
Issue comment event: 2
Push event: 63
Pull request review comment event: 1
Pull request review event: 10
Pull request event: 26
Create event: 16

Last Year

Release event: 15
Delete event: 9
Issue comment event: 2
Push event: 63
Pull request review comment event: 1
Pull request review event: 10
Pull request event: 26
Create event: 16

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 0
Total pull requests: 9
Average time to close issues: N/A
Average time to close pull requests: about 3 hours
Total issue authors: 0
Total pull request authors: 2
Average comments per issue: 0
Average comments per pull request: 0.33
Merged pull requests: 8
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 9
Average time to close issues: N/A
Average time to close pull requests: about 3 hours
Issue authors: 0
Pull request authors: 2
Average comments per issue: 0
Average comments per pull request: 0.33
Merged pull requests: 8
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Tom-van-Woudenberg (10)
douden (3)

Top Labels

Issue Labels

Pull Request Labels

Dependencies

.github/workflows/python-publish.yml actions

actions/checkout v4 composite
actions/download-artifact v4 composite
actions/setup-python v5 composite
actions/upload-artifact v4 composite
pypa/gh-action-pypi-publish release/v1 composite
sigstore/gh-action-sigstore-python v2.1.1 composite

pyproject.toml pypi

sphinx *

requirements.txt pypi

Sphinx <7.0

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science