-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4bdccae
commit ae5cd92
Showing
1 changed file
with
29 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,29 @@ | ||
# JupyterBook-Patches | ||
# 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. | ||
|
||
## 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 | ||
``` |