diff options
| author | Georg Brandl <georg@python.org> | 2012-01-29 12:06:02 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2012-01-29 12:06:02 +0100 |
| commit | 992d0879ae4ffcd7e9117a3b266173ce21ed5897 (patch) | |
| tree | 6e982c73e34f4b39dd6b177b068f2c07d9fb5e8c | |
| parent | ab0af1bd92011fc1cf39a8a698c7b513a5b670ee (diff) | |
| download | sphinx-992d0879ae4ffcd7e9117a3b266173ce21ed5897.tar.gz | |
Closes #817: note that math markup in docstrings needs to take care of backslashes.
| -rw-r--r-- | doc/ext/math.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/ext/math.rst b/doc/ext/math.rst index 434c657b..3652b55e 100644 --- a/doc/ext/math.rst +++ b/doc/ext/math.rst @@ -24,6 +24,10 @@ The input language for mathematics is LaTeX markup. This is the de-facto standard for plain-text math notation and has the added advantage that no further translation is necessary when building LaTeX output. +Keep in mind that when you put math markup in **Python docstrings** read by +:mod:`autodoc <sphinx.ext.autodoc>`, you either have to double all backslashes, +or use Python raw strings (``r"raw"``). + :mod:`.mathbase` defines these new markup elements: .. rst:role:: math |