Working with IPython Notebooks

Running IPython Notebooks

1. Open command line
2. CD to the directory where the notebook exists
3. Execute ipython notebook
4. Click on the notebook when the browser has loaded

Adding IPython Notebooks to Sphinx Docs

1. Place IPython notebook in the docs/notebooks directory
2. Create a RST file with the same name as the notebook (convention, doesn’t have to be the same)
3. Use the .. notebook:: thenameofyournotebook.ipynb rst directive within the notebook’s rst file to tell Sphinx to execute and insert the notebook
4. Reference thenameofyournotebook.rst file from some higher level Sphinx RST file