... | ... | @@ -3,7 +3,28 @@ |
|
|
## Haddock documentation
|
|
|
|
|
|
|
|
|
The GHC build includes Haddock, and the Haddock documentation for libraries is built and installed by default. It is also possible to process the libraries sources using [ HsColour](http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hscolour), and for the Haddock documentation to include links to the HsColoured source code; in order to do this, just install `HsColour` and run `./configure`. The configure script will tell you whether it found `HsColour` at the end.
|
|
|
The GHC build includes Haddock, and the Haddock documentation for libraries is built and installed by default.
|
|
|
|
|
|
|
|
|
You can disable Haddock documentation for your build by adding
|
|
|
|
|
|
```wiki
|
|
|
HADDOCK_DOCS = NO
|
|
|
```
|
|
|
|
|
|
|
|
|
to your `mk/build.mk`.
|
|
|
|
|
|
|
|
|
It is also possible to process the libraries sources using [ HsColour](http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hscolour), and for the Haddock documentation to include links to the HsColoured source code; in order to do this, just install `HsColour` and re-run `./configure`. The configure script will tell you whether it found `HsColour` at the end.
|
|
|
|
|
|
|
|
|
To build *just* the Haddock docs for a given library, do this:
|
|
|
|
|
|
```wiki
|
|
|
cd libraries/base
|
|
|
make html stage=0 FAST=YES
|
|
|
```
|
|
|
|
|
|
## DocBook documentation
|
|
|
|
... | ... | @@ -15,3 +36,31 @@ To install the tools necessary for building the documentation, see [Building/Pre |
|
|
|
|
|
|
|
|
At the moment, we are not able to build documentation in PDF format due to tool flakiness. If you manage to find a way to process the documentation into readable PDF, please let us know!
|
|
|
|
|
|
|
|
|
The following make variables control the building of each type of documentation:
|
|
|
|
|
|
```wiki
|
|
|
BUILD_DOCBOOK_HTML = YES/NO
|
|
|
BUILD_DOCBOOK_PS = YES/NO
|
|
|
BUILD_DOCBOOK_PDF = YES/NO
|
|
|
```
|
|
|
|
|
|
|
|
|
They are set to `YES` or `NO` in `mk/config.mk` by configure, depending on whether the necessary tools were detected on your system. You can override the automatic settings in your `mk/build.mk` file.
|
|
|
|
|
|
|
|
|
To build a document on its own, for example the Users Guide, do this:
|
|
|
|
|
|
```wiki
|
|
|
cd docs/users_guide
|
|
|
make html stage=0 FAST=YES
|
|
|
```
|
|
|
|
|
|
|
|
|
substitute 'html' for 'pdf' or 'ps' to build other types of documentation.
|
|
|
|
|
|
## Installing documentation
|
|
|
|
|
|
|
|
|
Documentation is installed by default by 'make install'. |