From ccd952f8741a1818afac6ee50a54c0a7f4dee4b3 Mon Sep 17 00:00:00 2001 From: Dominic Steinitz Date: Thu, 9 Jun 2016 09:27:28 +0100 Subject: Documentation for LaTeX markup. --- doc/markup.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'doc') 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 ~~~~~~~ -- cgit v1.2.3