DOC: Put more structure into the "links" notebook

spatialaudio · Jan 7, 2016 · 99ff542 · 99ff542
1 parent e486b95
commit 99ff542
Showing 1 changed file with 76 additions and 13 deletions.
diff --git a/doc/links.ipynb b/doc/links.ipynb
@@ -4,39 +4,102 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# External Links\n",
+    "# External Links"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**notebook_sphinxext.py**\n",
+    "\n",
+    "Notebooks can be included in `*.rst` files with a custom `notebook` directive.\n",
+    "Uses `runipy` to execute notebooks and `nbconvert` to convert the result to HTML.\n",
+    "\n",
+    "No LaTeX support.\n",
     "\n",
     "https://github.com/ngoldbaum/RunNotebook\n",
     "\n",
     "https://bitbucket.org/yt_analysis/yt-doc/src/default/extensions/notebook_sphinxext.py\n",
     "\n",
     "https://github.com/matthew-brett/perrin-academy/blob/master/sphinxext/notebook_sphinxext.py\n",
     "\n",
-    "http://sphinx-ipynb.readthedocs.org/\n",
+    "https://github.com/ipython/nbconvert/pull/35"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**nb2plots**\n",
     "\n",
-    "http://dongweiming.github.io/divingintoipynb_nikola/posts/nbconvert.html\n",
+    "Notebook to reStructuredText converter which uses a modified version of the matplotlib `plot` directive.\n",
     "\n",
-    "https://github.com/ipython/ipython/issues/4936\n",
+    "https://github.com/matthew-brett/nb2plots"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**brole**\n",
     "\n",
-    "https://mail.scipy.org/pipermail/ipython-user/2013-December/013490.html\n",
+    "A Sphinx role for IPython notebooks\n",
     "\n",
-    "https://github.com/ipython/nbconvert/pull/35\n",
+    "https://github.com/matthew-brett/brole"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**Sphinx-Gallery**\n",
     "\n",
-    "https://github.com/matthew-brett/brole\n",
+    "http://sphinx-gallery.readthedocs.org/"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**DocOnce**\n",
+    "\n",
+    "http://hplgit.github.io/doconce/doc/web/index.html"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**Converting Notebooks to reStructuredText**\n",
     "\n",
     "https://github.com/perrette/dimarray/blob/master/docs/scripts/nbconvert_to_rst.py\n",
     "\n",
-    "https://github.com/matthew-brett/nb2plots\n",
+    "https://gist.github.com/hadim/16e29b5848672e2e497c\n",
     "\n",
-    "https://github.com/getpelican/pelican-plugins/blob/master/liquid_tags/notebook.py\n",
+    "http://sphinx-ipynb.readthedocs.org/"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**Converting Notebooks to HTML for Blog Posts**\n",
     "\n",
-    "https://github.com/jupyter/nbconvert/issues/47\n",
+    "http://dongweiming.github.io/divingintoipynb_nikola/posts/nbconvert.html\n",
     "\n",
-    "http://hplgit.github.io/doconce/doc/web/index.html\n",
+    "https://github.com/getpelican/pelican-plugins/blob/master/liquid_tags/notebook.py"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**Further Posts and Issues**\n",
     "\n",
-    "http://sphinx-doc.org/extdev/\n",
+    "https://github.com/ipython/ipython/issues/4936\n",
     "\n",
-    "https://github.com/sphinx-doc/sphinx/issues/1907"
+    "https://mail.scipy.org/pipermail/ipython-user/2013-December/013490.html"
    ]
   }
  ],