From 474a0c182d6ef9a7e93e277a2755d04d943059a0 Mon Sep 17 00:00:00 2001 From: Sebastian Meric de Bellefon Date: Tue, 24 May 2016 17:36:34 -0400 Subject: remove framed view of the HTML documentation (see #114 and #274) Frames are a bit broken, ignored by Hackage, and considered obsolete in general. This patch disables frames generation. The mini_*.html files are still used in the synopsis. --- doc/invoking.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) (limited to 'doc') 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 -- cgit v1.2.3 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(+) (limited to 'doc') 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(-) (limited to 'doc') 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(-) (limited to 'doc') 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(-) (limited to 'doc') 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 From d1dc783cbf805e4169bf0528c57016ba175ad555 Mon Sep 17 00:00:00 2001 From: Omari Norman Date: Wed, 29 Jun 2016 21:59:34 -0400 Subject: Add $ as a special character If this character is not escaped, documentation built with Haddock 2.17.2 will fail. This was not an issue with 2.16 series, which causes builds to fail and there is nothing in the docs or error message giving a clue about why builds that used to succeed now don't. --- doc/markup.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/markup.rst b/doc/markup.rst index 78718c18..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 (``\\``). -- cgit v1.2.3