From 9bd2bf9e8cbf1b2cc2affd27096b79d149528c5b Mon Sep 17 00:00:00 2001 From: Njagi Mwaniki Date: Sat, 27 Dec 2014 23:28:59 +0300 Subject: Turn the README into GitHub Markdown format. Closes #354 --- doc/README | 26 -------------------------- doc/README.md | 25 +++++++++++++++++++++++++ 2 files changed, 25 insertions(+), 26 deletions(-) delete mode 100644 doc/README create mode 100644 doc/README.md (limited to 'doc') diff --git a/doc/README b/doc/README deleted file mode 100644 index 5bc038bf..00000000 --- a/doc/README +++ /dev/null @@ -1,26 +0,0 @@ -Haddock documentation ---------------------- - -The documentation is in DocBook XML format. You need some tools to -process it: at least xsltproc, and the DocBook XML DTD and XSL -stylesheets. There's a configure script to detect the right way to -process the documentation on your system, and a Makefile to actually -do the processing (so, on Windows, you'll need Cygwin or MSys in -addition to the DocBook XML tools). To build the HTML documentation: - - $ autoconf - $ ./configure - $ make html - -which leaves the HTML documentation in a haddock/ subdirectory. - -Printable documentation can also be produced, eg.: - - $ make pdf - -or - - $ make ps - -Generating the printed formats requires more tools (fop or xmltex) and -tends to be a bit harder. diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 00000000..cf1fc31b --- /dev/null +++ b/doc/README.md @@ -0,0 +1,25 @@ +# Haddock documentation + +The documentation is in DocBook XML format. You need some tools to +process it: at least xsltproc, and the DocBook XML DTD and XSL +stylesheets. There's a configure script to detect the right way to +process the documentation on your system, and a Makefile to actually +do the processing (so, on Windows, you'll need Cygwin or MSys in +addition to the DocBook XML tools). To build the HTML documentation: + + $ autoconf + $ ./configure + $ make html + +which leaves the HTML documentation in a haddock/ subdirectory. + +Printable documentation can also be produced, eg.: + + $ make pdf + +or + + $ make ps + +Generating the printed formats requires more tools (fop or xmltex) and +tends to be a bit harder. -- cgit v1.2.3 From 194f382f84a401a82464438820f074aa7851b725 Mon Sep 17 00:00:00 2001 From: Mateusz Kowalczyk Date: Wed, 3 Jun 2015 05:25:29 +0100 Subject: Update docs with info on new list nesting rule Fixes #278 through commits from PR #401 --- doc/haddock.xml | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'doc') diff --git a/doc/haddock.xml b/doc/haddock.xml index 2ffd7d78..f6cd4d4d 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -2029,7 +2029,18 @@ This belongs to the list above! 2. No newline separation even in indented lists. -} + The indentation of the first list item is honoured. That is, + in the following example the items are on the same level. Before + Haddock 2.16.1, the second item would have been nested under the + first item which was unexpected. + + +{-| + * foo + * bar +-} +
-- cgit v1.2.3 From d50967d6a20ec43b048b69122590b410ea872dc4 Mon Sep 17 00:00:00 2001 From: Mateusz Kowalczyk Date: Wed, 3 Jun 2015 05:29:26 +0100 Subject: Update some meta data at the top of the docs --- doc/haddock.xml | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/haddock.xml b/doc/haddock.xml index f6cd4d4d..b528fdb5 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -12,7 +12,7 @@ - 2004-08-02 + 2015-06-02 Haddock User Guide Simon @@ -24,12 +24,21 @@ Waern
david.waern@gmail.com
+ + Mateusz + Kowalczyk + +
fuuzetsu@fuuzetsu.co.uk
2010 Simon Marlow, David Waern + + 2013-2015 + Mateusz Kowalczyk + - This document describes Haddock version 2.15.1, a Haskell + This document describes Haddock version 2.16.1, a Haskell documentation tool. -- cgit v1.2.3 From 9c156cdcfd7d042ed9cfa242871846291af5cf0a Mon Sep 17 00:00:00 2001 From: Łukasz Hanuszczak Date: Sat, 4 Jul 2015 16:28:26 +0200 Subject: Update docs with information about source hyperlinking. --- doc/haddock.xml | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) (limited to 'doc') diff --git a/doc/haddock.xml b/doc/haddock.xml index b528fdb5..6c83f618 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -528,6 +528,43 @@ $ pdflatex package.tex + + + + + + + Generate hyperlinked source code (as HTML web page). All + rendered files will be put into + src/ subfolder of output + directory. + Usually, this should be used in combination with + option - generated documentation will then + contain references to appropriate code fragments. Previously, this + behaviour could be achieved by generating sources using external + tool and specifying , + , + and related options. Note that these flags are ignored once + is set. + In order to make cross-package source hyperlinking possible, + appropriate source paths have to be set up when providing + interface files using + option. + + + + + + + + + + Use custom CSS file for sources rendered by the + option. If no custom style + file is provided, Haddock will use default one. + + + -- cgit v1.2.3 From 820381b78d1f0f7487e120c22913629863a8d1eb Mon Sep 17 00:00:00 2001 From: Łukasz Hanuszczak Date: Sat, 4 Jul 2015 16:52:15 +0200 Subject: Update docs on using `--read-interface` option. --- doc/haddock.xml | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) (limited to 'doc') diff --git a/doc/haddock.xml b/doc/haddock.xml index 6c83f618..b28006f6 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -345,11 +345,27 @@ - path,file + file + + + + docpath,file + + + + docpath,srcpath,file + + + + =file - =path,file + =docpath,file + + + + =docpath,srcpath,file Read the interface file in @@ -357,19 +373,25 @@ produced by running Haddock with the option. The interface describes a set of modules whose HTML documentation is - located in path (which may be a - relative pathname). The path is - optional, and defaults to .. + located in docpath (which may be a + relative pathname). The docpath is + optional, and defaults to .. The + srcpath is optional but has no default + value. This option allows Haddock to produce separate sets of documentation with hyperlinks between them. The - path is used to direct hyperlinks + docpath is used to direct hyperlinks to point to the right files; so make sure you don't move the HTML files later or these links will break. Using a - relative path means that a + relative docpath means that a documentation subtree can still be moved around without breaking links. + Similarly to docpath, srcpath is used generate cross-package hyperlinks but + within sources rendered with + option. + Multiple options may be given. -- cgit v1.2.3 From 861c45b6c16e76e901553739bdb7d7c7e2f827f0 Mon Sep 17 00:00:00 2001 From: Łukasz Hanuszczak Date: Sat, 4 Jul 2015 17:43:22 +0200 Subject: Fix incorrect specification of source style option in doc file. --- doc/haddock.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc') diff --git a/doc/haddock.xml b/doc/haddock.xml index b28006f6..e2845212 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -577,8 +577,8 @@ $ pdflatex package.tex - - + + Use custom CSS file for sources rendered by the -- cgit v1.2.3 From b7fa3020ca8af55688c45a219a5418b21d91beec Mon Sep 17 00:00:00 2001 From: Mateusz Kowalczyk Date: Wed, 22 Jul 2015 22:03:21 +0100 Subject: Make some version changes after 2.16.1 release --- CHANGES | 10 ++++++---- doc/haddock.xml | 2 +- haddock-api/haddock-api.cabal | 2 +- haddock.cabal | 4 ++-- 4 files changed, 10 insertions(+), 8 deletions(-) (limited to 'doc') diff --git a/CHANGES b/CHANGES index be829adf..60d39605 100644 --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,9 @@ +Changes in version 2.16.2 + + * Generate hyperlinked source ourselves (#410, part of GSOC 2015) + + * Fix expansion icon for user-collapsible sections (#412) + Changes in version 2.16.1 * Don't default to type constructors for out-of-scope names (#253 and @@ -21,10 +27,6 @@ Changes in version 2.16.1 * Fix alignment of Source link for instances in Firefox (#384) - * Generate hyperlinked source ourselves (#410, part of GSOC 2015) - - * Fix expansion icon for user-collapsible sections (#412) - Changes in version 2.16.0 * Experimental collapsible header support (#335) diff --git a/doc/haddock.xml b/doc/haddock.xml index e2845212..e805a437 100644 --- a/doc/haddock.xml +++ b/doc/haddock.xml @@ -38,7 +38,7 @@ Mateusz Kowalczyk - This document describes Haddock version 2.16.1, a Haskell + This document describes Haddock version 2.16.2, a Haskell documentation tool. diff --git a/haddock-api/haddock-api.cabal b/haddock-api/haddock-api.cabal index 1e0b1eaf..4db05de8 100644 --- a/haddock-api/haddock-api.cabal +++ b/haddock-api/haddock-api.cabal @@ -1,5 +1,5 @@ name: haddock-api -version: 2.16.1 +version: 2.16.2 synopsis: A documentation-generation tool for Haskell libraries description: Haddock is a documentation-generation tool for Haskell libraries diff --git a/haddock.cabal b/haddock.cabal index 8fa9f33d..27ae8967 100644 --- a/haddock.cabal +++ b/haddock.cabal @@ -1,5 +1,5 @@ name: haddock -version: 2.16.1 +version: 2.16.2 synopsis: A documentation-generation tool for Haskell libraries description: Haddock is a documentation-generation tool for Haskell libraries @@ -59,7 +59,7 @@ executable haddock array, xhtml >= 3000.2 && < 3000.3, Cabal >= 1.10, - ghc >= 7.9 && < 7.11, + ghc >= 7.9 && < 7.12, bytestring, transformers -- cgit v1.2.3