Usage¶

Install nbsphinx with pip:

pip install nbsphinx --user


If you change your mind, you can un-install it with:

pip uninstall nbsphinx


Sphinx Setup¶

In the directory with your notebook files, run this command (assuming you have Sphinx installed already):

sphinx-quickstart


Answer the questions that appear on the screen. In case of doubt, just press the <Return> key to take the default values.

After that, there will be a few brand-new files in the current directory. You’ll have to make a few changes to the file named conf.py. You should at least check if those two variables contain the right things:

extensions = [
'nbsphinx',
'sphinx.ext.mathjax',
]
exclude_patterns = ['_build', '**.ipynb_checkpoints']


Once your conf.py is in place, edit the file named index.rst and add the file names of your notebooks (with or without the .ipynb extension) to the toctree directive.

Running Sphinx¶

To create the HTML pages, use this command:

sphinx-build <source-dir> <build-dir>


If you have many notebooks, you can do a parallel build by using the -j option:

sphinx-build <source-dir> <build-dir> -j<number-of-processes>


For example, if your source files are in the current directory and you have 4 CPU cores, you can run this:

sphinx-build . _build -j4


Afterwards, you can find the main HTML file in _build/index.html.

Subsequent builds will be faster, because only those source files which have changed will be re-built. To force re-building all source files, use the -E option.

To create LaTeX output, use:

sphinx-build <source-dir> <build-dir> -b latex


If you don’t know how to create a PDF file from the LaTeX output, you should have a look at Latexmk (see also this tutorial).

Watching for Changes with sphinx-autobuild¶

If you think it’s tedious to run the command sphinx-build again and again when you make changes to your notebooks, you’ll be happy to hear that there is a way to avoid that: sphinx-autobuild!

It can be installed with

pip install sphinx-autobuild --user


You can start auto-building your files with

sphinx-autobuild <source-dir> <build-dir>


This will start a local webserver which will serve the generated HTML pages at http://127.0.0.1:8000/. Whenever you save changes in one of your notebooks, the appropriate HTML page(s) will be re-built and when finished, your browser view will be refreshed automatically. Neat!

You can also abuse this to auto-build the LaTeX output:

sphinx-autobuild <source-dir> <build-dir> -b latex


However, to auto-build the final PDF file, you’ll need an additional tool. Again, you can use latexmk for this (see above). Change to the build directory and run

latexmk -pdf -pvc


If your PDF viewer isn’t opened because of LaTeX build errors, you can use the option -f to force creating a PDF file.

Automatic Creation of HTML and PDF output on readthedocs.org¶

This is very easy!

1. Create an account on https://readthedocs.org/ and add your Github/Bitbucket repository (or any publicly available Git/Subversion/Mercurial/Bazaar repository).

2. Create a file named requirements.txt (or whatever name you wish) in your repository containing the required pip packages:

nbsphinx
ipykernel

3. In the “Advanced Settings” on readthedocs.org, specify your requirements.txt file (or however you called it) in the box labelled “Requirements file”. Kinda obvious, isn’t it?

4. Still in the “Advanced Settings”, make sure the right Python interpreter is chosen. This must be the same version (2.x or 3.x) as you were using in your notebooks!

5. Make sure that in the “Settings” of your Github repository, under “Webhooks & services”, “ReadTheDocs” is listed and activated in the “Services” section. If not, use “Add service”. There is probably a similar thing for Bitbucket.

6. Done!

After that, you only have to “push” to your repository and the HTML pages and the PDF file of your stuff are automagically created on readthedocs.org. Awesome!

You can even have different versions of your stuff, just use Git tags and branches and select in the readthedocs.org settings (under “Admin”, “Versions”) which of those should be created.

HTML Themes¶

The nbsphinx extension does not provide its own theme, you can use any of the available themes or create a custom one, if you feel like it.

The following links show how the nbsphinx input and output cells look like in different themes.