Merge pull request matplotlib#10 from argriffing/update-math-extensions

tacaswell · tacaswell · commit 333f73609feb · 2014-12-29T15:40:36.000-05:00
MAINT : update the list of sphinx math extensions, and use mathjax by default
diff --git a/conf.py b/conf.py
@@ -22,17 +22,16 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['matplotlib.sphinxext.mathmpl',
-              'matplotlib.sphinxext.only_directives',
+extensions = ['matplotlib.sphinxext.only_directives',
               'matplotlib.sphinxext.plot_directive',
-              'matplotlib.sphinxext.ipython_directive',
+              'IPython.sphinxext.ipython_directive',
+              'IPython.sphinxext.ipython_console_highlighting',
+              'sphinx.ext.mathjax',
               'sphinx.ext.autodoc',
               'sphinx.ext.doctest',
               'sphinx.ext.inheritance_diagram',
-              'ipython_console_highlighting',
               'numpydoc']
 
-
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
diff --git a/extensions.rst b/extensions.rst
@@ -18,8 +18,7 @@ our :file:`sampledoc` project :file:`sphinxext` directory::
     home:~/tmp/sampledoc> mkdir sphinxext
     home:~/tmp/sampledoc> cp ../sampledoc_tut/sphinxext/*.py sphinxext/
     home:~/tmp/sampledoc> ls sphinxext/
-    apigen.py     docscrape_sphinx.py     ipython_console_highlighting.py
-    docscrape.py  inheritance_diagram.py  numpydoc.py
+    apigen.py  docscrape.py  docscrape_sphinx.py  numpydoc.py
 
 In addition to the builtin matplotlib extensions for embedding pyplot
 plots and rendering math with matplotlib's native math engine, we also
@@ -36,19 +35,17 @@ file by adding the following.  First we tell it where to find the extensions::
 
 And then we tell it what extensions to load::
 
-    # Add any Sphinx extension module names here, as strings. They can
-    # be extensions coming with Sphinx (named 'sphinx.ext.*') or your
-    # custom ones.
-    extensions = [
-              'matplotlib.sphinxext.mathmpl',
-              'matplotlib.sphinxext.only_directives',
-              'matplotlib.sphinxext.plot_directive',
-              'matplotlib.sphinxext.ipython_directive',
-              'sphinx.ext.autodoc',
-              'sphinx.ext.doctest',
-              'ipython_console_highlighting',
-              'inheritance_diagram',
-              'numpydoc']
+    # Add any Sphinx extension module names here, as strings. They can be extensions
+    # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+    extensions = ['matplotlib.sphinxext.only_directives',
+                  'matplotlib.sphinxext.plot_directive',
+                  'IPython.sphinxext.ipython_directive',
+                  'IPython.sphinxext.ipython_console_highlighting',
+                  'sphinx.ext.mathjax',
+                  'sphinx.ext.autodoc',
+                  'sphinx.ext.doctest',
+                  'sphinx.ext.inheritance_diagram',
+                  'numpydoc']
 
 Now let's look at some of these in action.  You can see the literal
 source for this file at :ref:`extensions-literal`.
@@ -115,25 +112,18 @@ which is rendered as
 
    W^{3\beta}_{\delta_1 \rho_1 \sigma_2} \approx U^{3\beta}_{\delta_1 \rho_1}
 
-This documentation framework includes a Sphinx extension,
-:file:`sphinxext/mathmpl.py`, that uses matplotlib to render math
-equations when generating HTML, and LaTeX itself when generating a
-PDF.  This can be useful on systems that have matplotlib, but not
-LaTeX, installed.  To use it, add ``mathmpl`` to the list of
-extensions in :file:`conf.py`.
+Recent versions of Sphinx include built-in support for math.
+There are three flavors:
 
-Current SVN versions of Sphinx now include built-in support for math.
-There are two flavors:
+  - sphinx.ext.pngmath: uses dvipng to render the equation
 
-  - pngmath: uses dvipng to render the equation
+  - sphinx.ext.mathjax: renders the math in the browser using Javascript
 
-  - jsmath: renders the math in the browser using Javascript
+  - sphinx.ext.jsmath: it's an older code, but it checks out
 
-To use these extensions instead, add ``sphinx.ext.pngmath`` or
-``sphinx.ext.jsmath`` to the list of extensions in :file:`conf.py`.
+Additionally, matplotlib has its own math support:
 
-All three of these options for math are designed to behave in the same
-way.
+  - matplotlib.sphinxext.mathmpl
 
 See the matplotlib `mathtext guide
 <http://matplotlib.sourceforge.net/users/mathtext.html>`_ for lots
diff --git a/sphinxext/ipython_console_highlighting.py b/sphinxext/ipython_console_highlighting.py
