Normal reStructuredText Files
This is a normal RST file.
Links to Notebooks
Links to notebooks can be easily created:
Notebooks in Sub-Directories
(the notebook title is used as link text).
You can also use
an alternative text.
The above links were created with:
:ref:`an alternative text </subdir/a-notebook-in-a-subdir.ipynb>`
Links to subsections are also possible, e.g.
(the subsection title is used as link text) and
These links were created with:
:ref:`alternative text </subdir/a-notebook-in-a-subdir.ipynb#A-Sub-Section>`
- Spaces in the section title have to be replaced by hyphens!
- Notebook paths have to be relative to the top source directory and they
have to start with a slash (
Sphinx Directives for Info/Warning Boxes
This is an experimental feature!
Its usage may change in the future or it might disappear completely, so
don’t use it for now.
With a bit of luck, it will be possible (some time in the future) to create
info/warning boxes in Markdown cells, see
If this ever happens,
nbsphinx will provide directives for creating such
For now, there are two directives available:
This is how an info box looks like:
This is an info box.
It may include nested formatting, even another info/warning box:
Warning: You should probably not use nested boxes!
This is just for testing domain object links. See
|Parameters:||foo (str) – Example string parameter