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(+) 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 From f453f37b178033ffa3b0d37707ee7fc8d1ddb8f5 Mon Sep 17 00:00:00 2001 From: Dominic Steinitz Date: Thu, 9 Jun 2016 09:33:59 +0100 Subject: Fix spelling mistake. --- doc/markup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/markup.rst b/doc/markup.rst index 733b810b..a270da27 100644 --- a/doc/markup.rst +++ b/doc/markup.rst @@ -803,7 +803,7 @@ Mathematics / LaTeX ~~~~~~~~~~~~~~~~~~~ Haddock supports LaTeX syntax for rendering mathematical notation. The -delimiters are ``\[...\]`` for displayed mathemetics and ``\(...\)`` +delimiters are ``\[...\]`` for displayed mathematics and ``\(...\)`` for in-line mathematics. An example looks like this: :: \[ -- cgit v1.2.3 From 6b075efec016e9a28e83d738893862145a7164d4 Mon Sep 17 00:00:00 2001 From: Dominic Steinitz Date: Thu, 9 Jun 2016 09:37:15 +0100 Subject: Camel case MathJax. --- doc/markup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/markup.rst b/doc/markup.rst index a270da27..bc27d34f 100644 --- a/doc/markup.rst +++ b/doc/markup.rst @@ -812,7 +812,7 @@ for in-line mathematics. An example looks like this: :: 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. +the mathematics via MathJax. Anchors ~~~~~~~ -- cgit v1.2.3 From 1f28fd887cd405ef5e31868ae51c32df2545e484 Mon Sep 17 00:00:00 2001 From: Dominic Steinitz Date: Thu, 9 Jun 2016 09:44:53 +0100 Subject: Fix math typo and add link. --- doc/markup.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/markup.rst b/doc/markup.rst index bc27d34f..78718c18 100644 --- a/doc/markup.rst +++ b/doc/markup.rst @@ -807,12 +807,12 @@ 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 + 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. +the mathematics via `MathJax `__. Anchors ~~~~~~~ -- cgit v1.2.3