diff options
| author | Ben Gamari <ben@smart-cactus.org> | 2016-02-12 10:04:22 +0100 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2016-02-12 10:04:22 +0100 |
| commit | e18d166b39cdc8c6672b626b4b840c1c383a9685 (patch) | |
| tree | 43aa1526b9980fdf9f6fc8cbd5a6027b9e82970c /doc/README.md | |
| parent | 57a5dcfd3d2a7e01229a2c3a79b1f99cd95d5de1 (diff) | |
| parent | 6a6029f1fc7b2cfeea8e231c8806d293d6644004 (diff) | |
Merge remote-tracking branch 'origin/master' into ghc-head
Diffstat (limited to 'doc/README.md')
| -rw-r--r-- | doc/README.md | 23 |
1 files changed, 4 insertions, 19 deletions
diff --git a/doc/README.md b/doc/README.md index cf1fc31b..947d7f93 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,25 +1,10 @@ # 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: +The documentation is in ReStructuredText format. You need +[Sphinx](http://www.sphinx-doc.org/) to process it. To build the HTML +documentation, - $ autoconf - $ ./configure $ make html -which leaves the HTML documentation in a haddock/ subdirectory. +which leaves the HTML documentation the `.build-html/` 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. |