diff options
| author | bond <diehose@freenet.de> | 2011-07-19 22:35:52 +0200 |
|---|---|---|
| committer | bond <diehose@freenet.de> | 2011-07-19 22:35:52 +0200 |
| commit | 8c9a595dbd163bc13486248211f3fdb43094e34b (patch) | |
| tree | 9c3f2c5a5696bd6ea919ef9b3dcb026496faab74 | |
| parent | 80afe4fb9ff0bf9a50a896ca0b262dfee0d04635 (diff) | |
| download | sphinx-8c9a595dbd163bc13486248211f3fdb43094e34b.tar.gz | |
some changes to math docs
| -rw-r--r-- | doc/ext/math.rst | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/doc/ext/math.rst b/doc/ext/math.rst index e6e1826b..6ae2c719 100644 --- a/doc/ext/math.rst +++ b/doc/ext/math.rst @@ -4,16 +4,15 @@ Math support in Sphinx ====================== .. module:: sphinx.ext.mathbase - :synopsis: Common math support for pngmath and jsmath. + :synopsis: Common math support for pngmath and mathjax / jsmath. .. versionadded:: 0.5 Since mathematical notation isn't natively supported by HTML in any way, Sphinx -supports math in documentation with two extensions. +supports math in documentation with several extensions. -The basic math support that is common to both extensions is contained in -:mod:`sphinx.ext.mathbase`. Other math support extensions should, -if possible, reuse that support too. +The basic math support is contained in :mod:`sphinx.ext.mathbase`. Other math +support extensions should, if possible, reuse that support too. .. note:: @@ -103,7 +102,8 @@ This extension renders math via LaTeX and dvipng_ into PNG images. This of course means that the computer where the docs are built must have both programs available. -There are various config values you can set to influence how the images are built: +There are various config values you can set to influence how the images are +built: .. confval:: pngmath_latex @@ -196,7 +196,7 @@ Sphinx. .. confval:: mathjax_path The path to the JavaScript file to include in the HTML files in order to load - JSMath. + MathJax. 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 @@ -206,7 +206,7 @@ Sphinx. The path can be absolute or relative; if it is relative, it is relative to the ``_static`` directory of the built docs. - For example, if you put JSMath into the static path of the Sphinx docs, this + For example, if you put MathJax into the static path of the Sphinx docs, this value would be ``MathJax/MathJax.js``. If you host more than one Sphinx documentation set on one server, it is advisable to install MathJax in a shared location. |