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



    :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


Orphan notebooks are not included in the LaTeX output!

Back to main page