diff options
author | Sebastian Méric de Bellefon <arnaudpourseb@gmail.com> | 2016-06-15 12:16:47 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-06-15 12:16:47 -0400 |
commit | 2c7c7359eca7c5e59d70958f9a9ef199476615c2 (patch) | |
tree | 6369e2ec83c346242dd1074771a58b8a8ff63ebb /doc/markup.rst | |
parent | 3b7166840552dc53694a8719c170251b89257792 (diff) | |
parent | 1f28fd887cd405ef5e31868ae51c32df2545e484 (diff) |
Merge pull request #525 from idontgetoutmuch/master
Documentation for LaTeX markup.
Diffstat (limited to 'doc/markup.rst')
-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..78718c18 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 mathematics 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 <https://www.mathjax.org>`__. + Anchors ~~~~~~~ |