From 21853a84be6394a11cd65777deb321b056e50da5 2012-01-29 06:29:33
From: Andrew Straw <strawman@astraw.com>
Date: 2012-01-29 06:29:33
Subject: [PATCH] add some documentation for URL prefix options

---

diff --git a/docs/source/interactive/htmlnotebook.txt b/docs/source/interactive/htmlnotebook.txt
index a829419..b765db2 100644
--- a/docs/source/interactive/htmlnotebook.txt
+++ b/docs/source/interactive/htmlnotebook.txt
@@ -357,6 +357,21 @@ uncomment and edit is here::
 You can then start the notebook and access it later by pointing your browser to
 ``https://your.host.com:9999``.
 
+Running with a different URL prefix
+===================================
+
+The notebook dashboard (i.e. the default landing page with an overview
+of all your notebooks) typically lives at a URL path of
+"http://localhost:8888/". If you want to have it, and the rest of the
+notebook, live under a sub-directory,
+e.g. "http://localhost:8888/ipython/", you can do so with command-line
+options like these:
+
+  $ ipython notebook --NotebookApp.webapp_settings="\
+         {'base_project_url':'/ipython/', \
+          'base_kernel_url':'/ipython/', \
+          'static_url_prefix':'/ipython/static/'}"
+
 .. _notebook_format:
 
 The notebook format