Haddock
Haddock is the standard tool for generating documentation from Haskell code.
Full documentation about Haddock itself can be found in the doc/
subdirectory,
in reStructuredText format.
Project overview
This project consists of three packages:
-
haddock
: provides thehaddock
executable. It is implemented as a tiny wrapper aroundhaddock-api
'sDocumentation.Haddock.haddock
function. -
haddock-api
: contains the program logic of thehaddock
tool. The haddocks for theDocumentation.Haddock
module offer a good overview of the functionality. -
haddock-library
: is concerned with the parsing and processing of the Haddock markup language. Unlike the other packages, it is expected to build on a fairly wide range of GHC versions.
Contributing
See CONTRIBUTING.md to see how to make contributions to the project.