summaryrefslogtreecommitdiff
path: root/doc/ext
diff options
context:
space:
mode:
authorGeorg Brandl <georg@python.org>2011-05-15 11:57:23 +0200
committerGeorg Brandl <georg@python.org>2011-05-15 11:57:23 +0200
commitd9a87a1d9d3cedc0024c1f1a278d02ad9ba3ecd7 (patch)
tree4f740f30da35d5bd18418a75c83c66a5af2a151f /doc/ext
parente69e36ea0e35f2efd5d5639e41bb9786fdb46ce5 (diff)
downloadsphinx-d9a87a1d9d3cedc0024c1f1a278d02ad9ba3ecd7.tar.gz
Closes #683: set default MathJax path to the CDN URL, and update the docs accordingly.
Diffstat (limited to 'doc/ext')
-rw-r--r--doc/ext/math.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/ext/math.rst b/doc/ext/math.rst
index 1c7332d6..e6e1826b 100644
--- a/doc/ext/math.rst
+++ b/doc/ext/math.rst
@@ -191,13 +191,17 @@ MathJax_ is then loaded and transforms the LaTeX markup to readable math live in
the browser.
Because MathJax (and the necessary fonts) is very large, it is not included in
-Sphinx. You must install it yourself, and give Sphinx its path in this config
-value:
+Sphinx.
.. confval:: mathjax_path
The path to the JavaScript file to include in the HTML files in order to load
- JSMath. There is no default.
+ JSMath.
+
+ The default is the ``http://`` URL that loads the JS files from the `MathJax
+ CDN <http://www.mathjax.org/docs/1.1/start.html>`_. If you want MathJax to
+ be available offline, you have to donwload it and set this value to a
+ different path.
The path can be absolute or relative; if it is relative, it is relative to
the ``_static`` directory of the built docs.
@@ -207,11 +211,7 @@ value:
documentation set on one server, it is advisable to install MathJax in a
shared location.
- You can also give a full ``http://`` URL. Kevin Dunn maintains a MathJax
- installation on a public server, which he offers for use by development and
- production servers::
-
- mathjax_path = 'http://mathjax.connectmv.com/MathJax.js'
+ You can also give a full ``http://`` URL different from the CDN URL.
:mod:`sphinx.ext.jsmath` -- Render math via JavaScript