Skip to content
Snippets Groups Projects
Commit 2c7c7359 authored by Helkafen's avatar Helkafen Committed by GitHub
Browse files

Merge pull request #525 from idontgetoutmuch/master

Documentation for LaTeX markup.
parents 3b716684 1f28fd88
No related branches found
No related tags found
No related merge requests found
......@@ -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
~~~~~~~
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment