Commits

Georg Brandl committed 581671a

Closes #817: note that math markup in docstrings needs to take care of backslashes.

Comments (0)

Files changed (1)

 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