Skip to content

Commit

Permalink
htmlnotebook doc updates
Browse files Browse the repository at this point in the history
* Indicate that MathJax will be loaded from CDN by default
* add missing markdown link and 
* a few typos
  • Loading branch information
minrk committed Aug 24, 2011
1 parent 28cf047 commit 7070308
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 5 deletions.
12 changes: 8 additions & 4 deletions docs/source/install/install.txt
Expand Up @@ -352,22 +352,26 @@ MathJax
-------

The IPython notebook uses the MathJax [MathJax]_ Javascript library for rendering LaTeX
in web browsers. Because MathJax is large, we don't include it with IPython. We do, however,
in web browsers. Because MathJax is large, we don't include it with IPython. Normally
IPython will load MathJax from a CDN, but if you have a slow network connection, or
want to use LaTeX without an internet connection at all, we do
include a utility to aid in downloading MathJax and installing it into the proper location::

from IPython.external.mathjax import install_mathjax
install_mathjax()

This function does require write access to the IPython install directory, so if you
have a system-wide Python install, it may need to be done from a ``sudo python`` session.

Browser Compatiblity
--------------------
Browser Compatibility
---------------------

The notebook uses WebSockets and the flexible box model. These features are
available in the following browsers:

* Chrome.
* Safari.
* Firefox 4 and 5. These browesrs have WebSocket support, but it is disabled by
* Firefox 4 and 5. These browsers have WebSocket support, but it is disabled by
default. You can enable it by entering ``about:config`` in the URL bar and then
setting ``network.websocket.enabled`` and ``network.websocket.override-security-block``
to ``true``.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/interactive/htmlnotebook.txt
Expand Up @@ -62,7 +62,7 @@ A notebook is a combination of two things:
1. an interactive session connected to an IPython kernel, controlled by a web
application that can send input to the console and display many types of output
(text, graphics, mathematics and more). This is the same kernel used by the
:ref:`Qt console <qt_console>`, but in this case the web console sends input in
:ref:`Qt console <qtconsole>`, but in this case the web console sends input in
persistent cells that you can edit in-place instead of the vertically scrolling
terminal style used by the Qt console.

Expand Down
1 change: 1 addition & 0 deletions docs/source/links.rst
Expand Up @@ -72,3 +72,4 @@
.. _indefero: http://www.indefero.net
.. _git: http://git-scm.com
.. _github: http://github.com
.. _MarkDown: http://daringfireball.net/projects/markdown/

0 comments on commit 7070308

Please sign in to comment.