Changes between Version 7 and Version 8 of Building/Docs


Ignore:
Timestamp:
Nov 13, 2009 1:08:34 PM (4 years ago)
Author:
simonmar
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Building/Docs

    v7 v8  
    55== Haddock documentation == 
    66 
    7 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 [http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hscolour 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. 
     7The GHC build includes Haddock, and the Haddock documentation for libraries is built and installed by default. 
    88 
     9You can disable Haddock documentation for your build by adding 
     10{{{ 
     11HADDOCK_DOCS = NO 
     12}}} 
     13to your `mk/build.mk`. 
     14 
     15It is also possible to process the libraries sources using [http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hscolour 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. 
     16 
     17To build ''just'' the Haddock docs for a given library, do this: 
     18{{{ 
     19cd libraries/base 
     20make html stage=0 FAST=YES 
     21}}} 
    922 
    1023== !DocBook documentation == 
     
    1528 
    1629At 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! 
     30 
     31To build a document on its own, for example the Users Guide, do this: 
     32 
     33{{{ 
     34cd docs/users_guide 
     35make html stage=0 FAST=YES 
     36}}} 
     37 
     38substitute 'html' for 'pdf' or 'ps' to build other types of documentation. 
     39 
     40== Installing documentation == 
     41 
     42Documentation is installed by default by 'make install'.