diff --git a/README.rst b/README.rst index ed2a222..2f52e32 100644 --- a/README.rst +++ b/README.rst @@ -16,6 +16,7 @@ install it along with the ReadTheDocs theme, run the following commands: pip install sphinx pip install sphinx-rtd-theme + pip install nbsphinx-link For a Linux system with `apt` (e.g. Ubuntu), you can do: @@ -23,7 +24,10 @@ For a Linux system with `apt` (e.g. Ubuntu), you can do: apt-get install python3-sphinx python3-sphinx-rtd-theme + Note: The `nbsphinx-link` package is needed to process Python notebook examples + but is not available via apt. It may be installed using pip: + pip install nbsphinx-link Compile the documentation -------------------------