# HG changeset patch
# User Georg Brandl
# Date 1327835162 -3600
# Branch stable
# Node ID 581671aee7ed10d0a1f1938dfcce65c41ecf452f
# Parent 1b25e0ec4ceef47cf36f458c4cb288b826281b8b
Closes #817: note that math markup in docstrings needs to take care of backslashes.
diff --git a/doc/ext/math.rst b/doc/ext/math.rst
--- a/doc/ext/math.rst
+++ b/doc/ext/math.rst
@@ -24,6 +24,10 @@
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