diff options
author | Dominic Steinitz <dominic@steinitz.org> | 2016-06-09 09:27:28 +0100 |
---|---|---|
committer | Dominic Steinitz <dominic@steinitz.org> | 2016-06-09 09:27:28 +0100 |
commit | ccd952f8741a1818afac6ee50a54c0a7f4dee4b3 (patch) | |
tree | e24891e360e859196cea299fb24840fa1b01c594 | |
parent | 3b7166840552dc53694a8719c170251b89257792 (diff) |
Documentation for LaTeX markup.
-rw-r--r-- | doc/markup.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/markup.rst b/doc/markup.rst index a2274ad6..733b810b 100644 --- a/doc/markup.rst +++ b/doc/markup.rst @@ -799,6 +799,21 @@ If the output format supports it, the image will be rendered inside the documentation. The image description is used as relpacement text and/or image title. +Mathematics / LaTeX +~~~~~~~~~~~~~~~~~~~ + +Haddock supports LaTeX syntax for rendering mathematical notation. The +delimiters are ``\[...\]`` for displayed mathemetics and ``\(...\)`` +for in-line mathematics. An example looks like this: :: + + \[ + f(a) = \frac{1}{2\pi i}\oint_\gamma \frac{f(z)}{z-a}\mathrm\,{d}z + \] + +If the output format supports it, the mathematics will be rendered +inside the documentation. For example, the HTML backend will display +the mathematics via mathjax. + Anchors ~~~~~~~ |