{ "cells": [ { "cell_type": "markdown", "metadata": { "nbsphinx": "hidden" }, "source": [ "This notebook is part of the `nbsphinx` documentation: http://nbsphinx.readthedocs.io/." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "# An Orphan Notebook (HTML Only)\n", "\n", "This means that is doesn't appear in a [toctree](http://www.sphinx-doc.org/en/stable/markup/toctree.html) (see `index.rst`), but other pages can still link to it ...\n", "\n", "* ... from a [Markdown cell of another notebook](markdown-cells.ipynb#Links-to-Other-Notebooks) using\n", "\n", " ```\n", " [some link text](notebookname.ipynb)\n", " ```\n", "\n", "* ... from a [reST page](a-normal-rst-file.rst#Links-to-Notebooks) using\n", "\n", " ```rst\n", " :ref:`/notebookname.ipynb`\n", " ```\n", "\n", " or\n", "\n", " ```rst\n", " :ref:`alternative link text `\n", " ```\n", "\n", "Sphinx raises a warning in case of orphaned documents:\n", "\n", " WARNING: document isn't included in any toctree\n", "\n", "If you want to avoid this warning, you can add this to the notebook's JSON metadata:\n", "\n", "```json\n", "\"nbsphinx\": {\n", " \"orphan\": true\n", "},\n", "```\n", "\n", "