Merge pull request #262 from takluyver/docs-4.x-misc

Browser compatibility info & misc cleanup

docs/source/conf.py

@@ -43,6 +43,7 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.autosummary',
     'sphinx.ext.mathjax',
+    'IPython.sphinxext.ipython_console_highlighting',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/source/links.txt

@@ -27,6 +27,7 @@
 .. Other python projects
 .. _matplotlib: http://matplotlib.org
 .. _nbviewer: http://nbviewer.jupyter.org
+.. _nbconvert: http://nbconvert.readthedocs.org/en/latest/
 
 .. Other tools and projects
 .. _Markdown: http://daringfireball.net/projects/markdown/syntax

docs/source/notebook.rst

@@ -65,22 +65,22 @@ colleagues.
 
 Notebooks may be exported to a range of static formats, including HTML (for
 example, for blog posts), reStructuredText, LaTeX, PDF, and slide shows, via
-the new :ref:`nbconvert <nbconvert:index>` command.
+the nbconvert_ command.
 
 Furthermore, any  ``.ipynb`` notebook document available from a public
 URL can be shared via the `Jupyter Notebook Viewer <nbviewer>`_ (nbviewer_).
 This service loads the notebook document from the URL and renders it as a
 static web page.  The results may thus be shared with a colleague, or as a
 public blog post, without other users needing to install the Jupyter notebook 
-themselves.  In effect, nbviewer_ is simply :ref:`nbconvert <nbconvert:index>` as 
+themselves.  In effect, nbviewer_ is simply nbconvert_ as
 a web service, so you can do your own static conversions with nbconvert, 
 without relying on nbviewer.
 
 
 
 .. seealso::
 
-    :ref:`Details on the notebook JSON file format <nbformat:format_description>`
+    :ref:`Details on the notebook JSON file format <nbformat:notebook_file_format>`
 
 
 Starting the notebook server
@@ -267,7 +267,7 @@ Raw cells
 
 *Raw* cells provide a place in which you can write *output* directly.
 Raw cells are not evaluated by the notebook.
-When passed through :ref:`nbconvert <nbconvert:index>`, raw cells arrive in the
+When passed through nbconvert_, raw cells arrive in the
 destination format unmodified. For example, this allows you to type full LaTeX
 into a raw cell, which will only be rendered by LaTeX after conversion by
 nbconvert.
@@ -361,15 +361,13 @@ Plotting
 One major feature of the Jupyter notebook is the ability to display plots that 
 are the output of running code cells. The IPython kernel is designed to work 
 seamlessly with the matplotlib_ plotting library to provide this functionality.  
-Specific plotting library integration is a feature of the kernel.  See the
-:ref:`plotting document <ipykernel:plotting>` of the IPython kernel for more
-information.
+Specific plotting library integration is a feature of the kernel.
 
 Installing kernels
 ------------------
 
-For information on how to install a Python kernel, refer to :ref:`IPython kernel's 
-installation document <ipykernel:kernel_install>`
+For information on how to install a Python kernel, refer to the `IPython install
+page <http://ipython.org/install.html>`__.
 
 Kernels for other languages can be found in the `IPython wiki
 <https://github.com/ipython/ipython/wiki/IPython%20kernels%20for%20other%20languages>`_.
@@ -405,3 +403,26 @@ You can generate a new notebook signing key with::
     $ jupyter trust --reset
 
 .. include:: links.txt
+
+Browser Compatibility
+---------------------
+
+The Jupyter Notebook is officially supported on the following browsers:
+
+* Chrome ≥ 13
+* Safari ≥ 5
+* Firefox ≥ 6
+
+The is mainly due to the notebook's usage of WebSockets and the flexible box model.
+
+The following browsers are unsupported:
+
+* Safari < 5
+* Firefox < 6
+* Chrome < 13
+* Opera (any): CSS issues, but execution might work
+* Internet Explorer < 10
+* Internet Explorer ≥ 10 (same as Opera)
+
+Using Safari with HTTPS and an untrusted certificate is known to not work
+(websockets will fail).

docs/source/public_server.rst

@@ -4,7 +4,7 @@ Running a notebook server
 =========================
 
 
-The  :ref:`Jupyter notebook <notebook>` web-application is based on a
+The :doc:`Jupyter notebook <notebook>` web-application is based on a
 server-client structure.  This server uses a :ref:`two-process kernel
 architecture <ipython:ipythonzmq>` based on ZeroMQ_, as well as Tornado_ for serving
 HTTP requests. By default, a notebook server runs on http://127.0.0.1:8888/
@@ -24,19 +24,19 @@ Securing a notebook server
 
 You can protect your notebook server with a simple single password by
 setting the :attr:`NotebookApp.password` configurable. You can prepare a
-hashed password using the function :func:`IPython.lib.security.passwd`:
+hashed password using the function :func:`notebook.auth.security.passwd`:
 
 .. sourcecode:: ipython
 
-    In [1]: from IPython.lib import passwd
+    In [1]: from notebook.auth import passwd
     In [2]: passwd()
     Enter password: 
     Verify password: 
     Out[2]: 'sha1:67c9e60bb8b6:9ffede0825894254b2e042ea597d771089e11aed'
 
 .. note::
 
-  :func:`~IPython.lib.security.passwd` can also take the password as a string
+  :func:`~notebook.auth.security.passwd` can also take the password as a string
   argument. **Do not** pass it as an argument inside an IPython session, as it
   will be saved in your input history.