-
Notifications
You must be signed in to change notification settings - Fork 386
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Jupytext menu made compatible with jupyter_nbextensions_configurator
Fixes #178
- Loading branch information
Showing
7 changed files
with
55 additions
and
6 deletions.
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
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
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 |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# A Jupyter notebook extension for Jupytext | ||
|
||
This extension adds a [Jupytext](https://github.com/mwouts/jupytext/blob/master/README.md) menu to Jupyter notebook. Use the menu to select the desired ipynb/text pairing for your notebook. | ||
|
||
![Jupytext menu screenshot](jupytext_menu.png) | ||
|
||
## Installation | ||
|
||
The extension requires [Jupytext](https://github.com/mwouts/jupytext/blob/master/README.md). Please make sure that Jupytext is installed on you system, and that its contents manager is active, i.e. that Markdown files and scripts are displayed with a notebook icon. | ||
|
||
Installing Jupytext activates the Jupytext Menu by default. If you want to install and activate it manually, use the following commands: | ||
|
||
```bash | ||
jupyter nbextension install --py jupytext | ||
jupyter nbextension enable --py jupytext | ||
``` | ||
|
||
Add `--user` to these commands if you want to activate the extension only for the current user. | ||
|
||
## How to develop this extension | ||
|
||
If you wish to develop this extension, install the javascript file locally with: | ||
|
||
```bash | ||
cd jupytext/nbextension | ||
jupyter nbextension install index.js --symlink --user | ||
jupyter nbextension enable jupytext --user | ||
``` | ||
|
||
Then, make the desired changes to `index.js` and reload the extension by simply refreshing the notebook (Ctrl+R). In case your OS does not allow symlinks, edit the copy of `index.js` that is actually used by Jupyter (refer to the output of `jupyter nbextension install --user index.js`). |
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 |
---|---|---|
@@ -0,0 +1,12 @@ | ||
Type: Jupyter Notebook Extension | ||
Name: Jupytext | ||
Section: notebook | ||
Description: Jupytext Menu | ||
tags: | ||
- version control | ||
- markdown | ||
- script | ||
Link: README.md | ||
Icon: jupytext_menu_zoom.png | ||
Main: index.js | ||
Compatibility: 5.x |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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