aboutsummaryrefslogtreecommitdiff
path: root/doc/sphinx
diff options
context:
space:
mode:
authorClément Pit-Claudel2018-09-25 10:43:42 +0200
committerThéo Zimmermann2018-09-25 12:45:57 +0200
commit44e9654d053b72931866d61b859ba831982c14fd (patch)
tree998e0f99cd7f7642c8ea6cd3cf0beed03a0598c1 /doc/sphinx
parent7eb8a7eb8d23ffaf149f71a46fb1b089b90db7f8 (diff)
[doc] Fix GH-8529: wrap macro definitions in math delimiters for MathJax
Diffstat (limited to 'doc/sphinx')
-rw-r--r--doc/sphinx/README.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/sphinx/README.rst b/doc/sphinx/README.rst
index 904945a58d..4ad952bdfb 100644
--- a/doc/sphinx/README.rst
+++ b/doc/sphinx/README.rst
@@ -292,7 +292,9 @@ In addition to the objects above, the ``coqrst`` Sphinx plugin defines the follo
\WTEG{\forall~x:T,U}{\Prop}
``.. preamble::`` A reST directive to include a TeX file.
- Mostly useful to let MathJax know about `\def`s and `\newcommand`s.
+ Mostly useful to let MathJax know about `\def`s and `\newcommand`s. The
+ contents of the TeX file are wrapped in a math environment, as MathJax
+ doesn't process LaTeX definitions otherwise.
Usage::