IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Closes #683: set default MathJax path to the CDN URL, and update the docs accordingly.

Browse Source
This commit is contained in:
Georg Brandl 2011-05-15 11:57:23 +02:00
parent 8a08f5b42a
commit 99c505b63f
2 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/ext/math.rst
View File

@ -191,13 +191,17 @@ MathJax_ is then loaded and transforms the LaTeX markup to readable math live in
the browser. the browser.
Because MathJax (and the necessary fonts) is very large, it is not included in 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 Sphinx.
value:
.. confval:: mathjax_path .. confval:: mathjax_path
The path to the JavaScript file to include in the HTML files in order to load 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 path can be absolute or relative; if it is relative, it is relative to
the ``_static`` directory of the built docs. 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 documentation set on one server, it is advisable to install MathJax in a
shared location. shared location.
You can also give a full ``http://`` URL. Kevin Dunn maintains a MathJax You can also give a full ``http://`` URL different from the CDN URL.
installation on a public server, which he offers for use by development and
production servers::
mathjax_path = 'http://mathjax.connectmv.com/MathJax.js'
:mod:`sphinx.ext.jsmath` -- Render math via JavaScript :mod:`sphinx.ext.jsmath` -- Render math via JavaScript

5
sphinx/ext/mathjax.py
View File

@ -60,8 +60,9 @@ def builder_inited(app):
def setup(app): def setup(app):
mathbase_setup(app, (html_visit_math, None), (html_visit_displaymath, None)) mathbase_setup(app, (html_visit_math, None), (html_visit_displaymath, None))
app.add_config_value('mathjax_path', '', False) app.add_config_value('mathjax_path',
'http://cdn.mathjax.org/mathjax/latest/MathJax.js?'
'config=TeX-AMS-MML_HTMLorMML', False)
app.add_config_value('mathjax_inline', [r'\(', r'\)'], 'html') app.add_config_value('mathjax_inline', [r'\(', r'\)'], 'html')
app.add_config_value('mathjax_display', [r'\[', r'\]'], 'html') app.add_config_value('mathjax_display', [r'\[', r'\]'], 'html')
app.connect('builder-inited', builder_inited) app.connect('builder-inited', builder_inited)