@hackage / haddock

A documentation-generation tool for Haskell libraries

Latest2.29.1

About

Metadata

  • Last updated , by BenGamari
  • License BSD-3-Clause
  • Categories Development

  • Maintained by: Alec Theriault <alec.theriault@gmail.com>, Alex Biehl <alexbiehl@gmail.com>, Simon Hengel <sol@typeful.net>, Mateusz Kowalczyk <fuuzetsu@fuuzetsu.co.uk>

  • Lottery factor: 0

Links

Installation

Tested Compilers

  1. 9.6.7
  2. 9.6.6
  3. 9.6.5
  4. 9.6.4
  5. 9.6.3
  6. 9.6.2
  7. 9.6.1

Package Flags

Use the -f option with cabal commands to enable flags

    in-ghc-tree (off by default)

    Are we in a GHC tree?

Readme

Haddock CI Hackage

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 the haddock executable. It is implemented as a tiny wrapper around haddock-api's Documentation.Haddock.haddock function.

  • haddock-api: contains the program logic of the haddock tool. The haddocks for the Documentation.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.