diff options
| author | Ben Gamari <ben@smart-cactus.org> | 2017-03-23 09:25:33 -0400 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2017-03-23 09:25:33 -0400 |
| commit | 606da884355527051afe0058c2f8b0ac2005e01b (patch) | |
| tree | 9388f16cb30761dd3f37c0bd3b6e251f9ebc2f87 /doc | |
| parent | 4eb765ca4205c79539d60b7afa9b7e261a4a49fe (diff) | |
| parent | 240bc38b94ed2d0af27333b23392d03eeb615e82 (diff) | |
Merge commit '240bc38b94ed2d0af27333b23392d03eeb615e82' into HEAD
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/invoking.rst | 8 | ||||
| -rw-r--r-- | doc/markup.rst | 17 |
2 files changed, 18 insertions, 7 deletions
diff --git a/doc/invoking.rst b/doc/invoking.rst index 13cb9f1e..83087bac 100644 --- a/doc/invoking.rst +++ b/doc/invoking.rst @@ -100,7 +100,7 @@ The following options are available: ``module.html``; ``mini_module.html`` An HTML page for each module, and a "mini" page for each used - when viewing in frames. + when viewing their synopsis. ``index.html`` The top level page of the documentation: lists the modules @@ -111,17 +111,13 @@ The following options are available: The alphabetic index, possibly split into multiple pages if big enough. - ``frames.html`` - The top level document when viewing in frames. - ``some.css``; ``etc...`` Files needed for the themes used. Specify your themes using the :option:`--theme` option. ``haddock-util.js`` Some JavaScript utilities used to implement some of the dynamic - features like collapsible sections, and switching to frames - view. + features like collapsible sections. .. option:: --latex diff --git a/doc/markup.rst b/doc/markup.rst index a2274ad6..b0ebc738 100644 --- a/doc/markup.rst +++ b/doc/markup.rst @@ -501,7 +501,7 @@ Special characters ~~~~~~~~~~~~~~~~~~ The following characters have special meanings in documentation -comments: ``\\``, ``/``, ``'``, ``\```, ``"``, ``@``, ``<``. To insert a +comments: ``\\``, ``/``, ``'``, ``\```, ``"``, ``@``, ``<``, ``$``. To insert a literal occurrence of one of these special characters, precede it with a backslash (``\\``). @@ -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 ~~~~~~~ |