From 992d0879ae4ffcd7e9117a3b266173ce21ed5897 Mon Sep 17 00:00:00 2001 From: Georg Brandl Date: Sun, 29 Jan 2012 12:06:02 +0100 Subject: Closes #817: note that math markup in docstrings needs to take care of backslashes. --- doc/ext/math.rst | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'doc/ext') 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 `, you either have to double all backslashes, +or use Python raw strings (``r"raw"``). + :mod:`.mathbase` defines these new markup elements: .. rst:role:: math -- cgit v1.2.1