aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/markup.rst15
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
~~~~~~~