Normal reStructuredText Files¶
This is a normal RST file.
Note
Those still work!
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:`/subdir/a-notebook-in-a-subdir.ipynb`
:ref:`an alternative text </subdir/a-notebook-in-a-subdir.ipynb>`
Links to subsections are also possible, e.g. A Sub-Section (the subsection title is used as link text) and alternative text.
These links were created with:
:ref:`/subdir/a-notebook-in-a-subdir.ipynb#A-Sub-Section`
:ref:`alternative text </subdir/a-notebook-in-a-subdir.ipynb#A-Sub-Section>`
Note
- 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¶
Warning:
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
https://github.com/jupyter/notebook/issues/1292.
If this ever happens, nbsphinx will provide directives for creating such
boxes.
For now, there are two directives available: nbinfo and nbwarning.
This is how an info box looks like:
Note:
This is an info box.
It may include nested formatting, even another info/warning box:
Domain Objects¶
-
example_python_function(foo)¶ This is just for testing domain object links. See this section.
Parameters: foo (str) – Example string parameter