@hackage haddock2.29.0
A documentation-generation tool for Haskell libraries
Categories
License
BSD-3-Clause
Maintainer
Alec Theriault <alec.theriault@gmail.com>, Alex Biehl <alexbiehl@gmail.com>, Simon Hengel <sol@typeful.net>, Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>
Links
Versions
Installation
Tested Compilers
Dependencies (0)
- array
- base ^>=4.13.0.0 || ^>=4.14.0.0 || ^>=4.15.0.0 || ^>=4.16.0.0 || ^>=4.17.0.0 || ^>=4.18.0.0 || ^>=4.19.0.0
- bytestring
- containers
- deepseq
- directory Show all…
Dependents (15)
@hackage/Hs2lib, @hackage/test-framework-doctest, @hackage/leksah-server, @hackage/haddocset, @hackage/DocTest, @hackage/acme-everything, Show all…
Package Flags
in-ghc-tree
(off by default)
Are we in a GHC tree?
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 thehaddockexecutable. It is implemented as a tiny wrapper aroundhaddock-api'sDocumentation.Haddock.haddockfunction. -
haddock-api: contains the program logic of thehaddocktool. The haddocks for theDocumentation.Haddockmodule 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.