An Orphan Notebook (HTML Only)¶
This means that is doesn’t appear in a
toctree
(see index.rst
), but other pages can still link to it …
… from a Markdown cell of another notebook using
[some link text](notebookname.ipynb)
… from a reST page using
rst :ref:`notebookname.ipynb`
or
rst :ref:`alternative link text <notebookname.ipynb>`
Sphinx raises a warning in case of orphaned documents:
WARNING: document isn't included in any toctree
If you want to avoid this warning, you can add this to the notebook’s JSON metadata:
"nbsphinx": {
"orphan": true
},
Note:
Orphan notebooks are not included in the LaTeX output!