File: README

package info (click to toggle)
haskell-haddock 2.13.1-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,084 kB
  • ctags: 73
  • sloc: haskell: 6,981; xml: 1,648; yacc: 139; makefile: 7; sh: 1
file content (26 lines) | stat: -rw-r--r-- 743 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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.