An Orphan NotebookΒΆ

This means that is doesn’t appear in the Sphinx 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

    :doc:`notebookname`
    

    or

    :doc:`alternative link text <notebookname>`
    

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!

Back to main page