TOC doesnt load?

Question

TOC doesnt load?

diego898 opened this issue 10 years ago · 26 comments

Hello,

I am on windows running the conda suite of packages and have ipython 2.3.1. I ahve followed the steps for the table of contents, placing

$([IPython.events]).on("app_initialized.NotebookApp", function () {
    IPython.load_extensions("toc");
});

in my C:\Users\diego\.ipython\profile_default\static\custom\custom.js file. I restart ipython and do not see any indication that the TOC extension is working.

Answer 1 · 2015-02-16T11:20:01.000Z

same with me on anaconda.

but with the following change in custom.js it works:

$([IPython.events]).on("notebook_loaded.Notebook", function () {
    IPython.load_extensions("toc");
});

See also:
http://nbviewer.ipython.org/github/ahambi/140824-TOC/blob/master/A%20floating%20table%20of%20contents.ipynb

Answer 2 · 2015-02-23T18:56:52.000Z

@dacoex Thanks for the suggestion, but that still doesn't do anything for me. :L

Answer 3 · 2015-02-23T21:21:18.000Z

Hey @diego898,

I am having a similar issue and the javascript is throwing an odd error. In the function toc_button I get an uncaught type error which states "cannot read property 'toolbar' of type undefined." This is called by load_ipython_extension in toc.js which is the entry point from utils.js.

Hopefully this points to the problem source.

Cheers, Matt

Answer 4 · 2015-02-25T15:24:55.000Z

I think it depends on the IPython version which mode of loading you choose.

Answer 5 · 2015-02-25T17:07:35.000Z

@dacoex I've tried both methods: the one in the readme and hte one you suggested with ipython version: 2.3.1 and I couldnt anything to show up.

Answer 6 · 2015-02-25T20:10:36.000Z

This extension only works with IPython 3.x

Answer 7 · 2015-02-25T22:14:02.000Z

@minrk - I am using 3.4 and still have the same error...

Answer 8 · 2015-02-25T22:48:31.000Z

IPython version 3.x, not Python 3. There is no IPython 3.4 yet.

Answer 9 · 2015-02-25T23:28:25.000Z

Is there an archived version of the TOC extension that works for IPython 2.3.x (or 2.4.x)?
It used to work fine for me on my anaconda distribution, but has now stopped working. It's a great extension and I'm really missing it :-(

Answer 10 · 2015-02-25T23:29:55.000Z

same here.

Answer 11 · 2015-02-25T23:33:40.000Z

Thanks, @minrk.... I was looking a the python distribution, not the ipython version. I am going to second @dreme - I can not seem to upgrade to the current development version of ipython (Window's 8).

Answer 12 · 2015-02-25T23:44:24.000Z

The 2.x branch of this repo marks the last commit before 3.x changes started happening. There may have been fixes since then that aren't backported.

https://github.com/minrk/ipython_extensions/tree/2.x

If you have fixes for 2.x, feel free to make PRs against that branch.

Answer 13 · 2015-02-26T00:07:16.000Z

thanks @minrk !

The following works for me:

curl https://raw.githubusercontent.com/minrk/ipython_extensions/2.x/nbextensions/toc.js > $(ipython locate)/nbextensions/toc.js
curl https://raw.githubusercontent.com/minrk/ipython_extensions/2.x/nbextensions/toc.css > $(ipython locate)/nbextensions/toc.css

and IPython.load_extensions('toc'); in my custom.js

Answer 14 · 2015-02-26T00:23:05.000Z

Thanks minrk for the pointer to the 2.x branch, and good to see that it works for diego.

Sadly, it is still not working for me. Can I check with you guys that I'm putting the appropriate files in the right folders. I have an anaconda python distro on windows 7 and my .ipython folder sits in my home folder:

2.x versions of toc.css and toc.js files in the .ipython/nbextensions folder
custom.js file (with dacoex's suggested loading script) in the .ipython\profile_default\static\custom folder

I'm having the same problem in Chrome and Firefox, so don't think it is browser related.

Answer 15 · 2015-02-26T00:32:57.000Z

I have anaconda on windows 8. My custom.js is in:
I have IPython.load_extensions('toc'); in: C:\Users\diego\.ipython\profile_default\static\custom\custom.js

Some notes:

make sure you used the commands I pasted above to make sure you're grabbing the 2.x versions.
after installing them, I shut down ipython, restarted chrome and restarted ipython

Answer 16 · 2015-02-26T00:40:33.000Z

Thanks Diego, I've just been doing a 'copy and paste' from minrk's github pages to get the toc.css and toc.js scripts.

How did you execute the curl command in Windows, as it doesn't work in the windows cmd shell

Answer 17 · 2015-02-26T00:42:42.000Z

I ran it using git bash. You can also just download them using these links:

https://raw.githubusercontent.com/minrk/ipython_extensions/2.x/nbextensions/toc.js
https://raw.githubusercontent.com/minrk/ipython_extensions/2.x/nbextensions/toc.css

and place them manually in: C:\Users\YOURNAME\.ipython\nbextensions\

Answer 18 · 2015-02-26T00:59:33.000Z

Thanks Diego.

I've used Git Shell to execute the curl commands for downloading the 2.x toc.css and toc.js files, and put them in the nbextensions folder, and also updated my custom.js file. I also shut down the ipython notebook server and my browser.

But unfortunately the TOC extension still doesn't load.

I'll try rebooting my computer to see if that helps ...

Answer 19 · 2015-02-26T01:08:19.000Z

Nope, the reboot didn't work. Dang, this is frustrating ...

Answer 20 · 2015-04-29T20:24:22.000Z

Hello! @minrk unexpectedly this problem reappeared for me today, even though it was working for me after I upgraded to ipython 3.x

It was working fine, but today it wont load anymore though I have all the files in place and have placed the loading snippet in custom.js

EDIT: restarting ipython+chrome wasnt enough. I had to restart the computer then the TOC appeared.

Answer 21 · 2015-09-15T21:21:32.000Z

I got the TOC extension to work in IPython 4 / Jupyter.

It wasn't working following the provided installation instructions, giving the following error in the javascript console:

Loaded extension: toc
Uncaught TypeError: Cannot read property 'load_ipython_extension' of undefined

However, when I moved the toc.js and toc.css files to the .jupyter/data/nbextensions/usability/toc folder, and added a line "usability/toc/toc": true to the .jupyter/nbconfig/notebook.json file, everything worked!

Here are the complete instructions:

Set JUPYTER_CONFIG_DIR and JUPYTER_DATA_DIR environmental variables in ~/.bashrc, so that there are no surprises:
```
export JUPYTER_CONFIG_DIR=$HOME/.jupyter
export JUPYTER_DATA_DIR=$HOME/.jupyter/data
```
Install nbextensions by cloning the git repository and running python setup.py install.
Open a notebook using jupyter notebook, and activate some nbextensions by navigating to the http://localhost:8888/nbextensions/ page. This should create an notebook.json file in your $JUPYTER_CONFIG_DIR/nbconfig/ directory.
Move toc.js and toc.css files to the $JUPYTER_DATA_DIR/nbextensions/usability/toc folder, and add a line "usability/toc/toc": true to your notebook.json file.

Restart your notebook, and everything should work!

Answer 22 · 2015-09-16T16:47:06.000Z

@ostrokach I don't have a ~/.jupyter/data directory!

Answer 23 · 2015-09-16T18:27:06.000Z

@diego898 The default JUPYTER_DATA_DIR is platform specific. You can see what it is on your system using the command:

python -c "from jupyter_core.paths import jupyter_data_dir; print(jupyter_data_dir());"

You can change it to whatever you like by exporting the JUPYTER_DATA_DIR environment variable. I saw someone else doing export JUPYTER_DATA_DIR=$JUPYTER_CONFIG_DIR/data in their ~/.bashrc, and I liked that idea because it's much more consistent with how IPython did things.

Either way, that folder may be empty until you install nbextensions.

For more info, see here: http://jupyter-core.readthedocs.org/en/latest/paths.html.

Answer 24 · 2015-11-08T06:44:40.000Z

Hi @ostrokach, thanks for your instructions on getting the TOC extension to work in IPython 4 / Jupyter

I'm trying to apply them for a Win7 python anaconda installation. Unfortunately I get stuck on your first instruction for installing nbextensions, using:

conda install -c http://conda.anaconda.org/juhasch nbextensions

Unfortunately this leads to the following error:

Fetching package metadata: ......
Solving package specifications: .............
Error: Unsatisfiable package specifications.
Generating hint:
Hint: the following packages conflict with each other:
   - nbextensions
   - python 2.7*
Use 'conda info nbextensions' etc. to see the dependencies for each package.
Note that the following features are enabled:
  - vc9

Any ideas?

Answer 25 · 2015-11-08T22:10:45.000Z

Hey @dreme,

You are getting that error because you are using Python 2.7 and the juhasch anaconda channel has nbextension binaries only for Python 3.4 (see https://anaconda.org/juhasch/nbextensions/files).
You should download nbextensions from github (press the Download ZIP button, or clone the repository using git), and install it by typing python setup.py install.

I never use windows so can't give you more help than that.

Answer 26 · 2015-11-08T22:56:14.000Z

Hi @ostrokach, thank you very much. I now have the TOC extension working, along with a whole heap of other goodies in the notebook extension package that you kindly referred me to