16

I am writing documentation for a notebook-based framework. When referring to important cells in a demo-notebook, can I point to a particular cell by using some sort of anchor?

For example if I have the demo-notebook at 127.0.0.1/mydemo, is it possible to refer to the input cell In[10] by some anchor tag like 127.0.0.1/mydemo#In10

nom-mon-ir
  • 3,748
  • 8
  • 26
  • 42

3 Answers3

22

Creating internal links within Markdown works quite well in practice for me. For example, you can make a table of contents by making a list in a markdown cell at the top of the page.

*[jump to code cell 2](#cell2)
*[jump to code cell 3](#cell3)
*[jump to code cell 4](#cell4)

Then you just insert a markdown cell right above the code cell you want to link to (say code cell 2). Just add one line of code:

<a id="cell2"></a>

See this tutorial for more explanation: http://nbviewer.ipython.org/github/rasbt/python_reference/blob/master/tutorials/table_of_contents_ipython.ipynb

digbyterrell
  • 3,449
  • 2
  • 24
  • 24
7

I like to use headers to organize my notebooks, such as

#My title

in a markdown cell. In another location, I can then refer to this cell using

[Link to my title](#My-title)

in markdown (looks like you should replace spaces with hyphens).

I got this from a more complete answer here.

Community
  • 1
  • 1
beardc
  • 20,283
  • 17
  • 76
  • 94
5

Not on stable, and only on Header(1-6) cell on master. Just click on the header cell and it will put the right anchor in the url bar, wich is usually #header_title_sanitized Using the prompt number is not a good idea as it might change. It will be supported on nbviewer as well, we are working on it.

Matt
  • 27,170
  • 6
  • 80
  • 74
  • 1
    IPython 1.0 is "due" mid July, feature is already on master for adventurous. No ETA for nbviewer, probably around the same time. – Matt May 20 '13 at 06:46