Text.PrettyPrint.GHCi.Haddock

Documentation

prettyPrintHaddock :: Bool -> String -> IO ()

Given a Haddock-formatted docstring, format and print that docstring to the terminal.

The Bool is to enable a slower but potentially smarter layout algorithm.

haddock2Doc :: String -> Doc AnsiStyle

Parse a docstring into a pretty Doc. Should never throw an exception (since haddock-library will parse something out of any input).

data HaddockPrintConf

Options for how to colour the terminal output

Constructors

HaddockPrintConf

Fields

• hpc_default :: AnsiStyle

  the default background

• hpc_emphasis :: AnsiStyle

  emphasized text

• hpc_bold :: AnsiStyle

  bold text

• hpc_monospaced :: AnsiStyle

  code blocks and inline code

• hpc_header :: AnsiStyle

  header bodies

• hpc_identifier :: AnsiStyle

  identifiers, module links, anchors

• hpc_math :: AnsiStyle

  \( ... \) and \[ ... \] delimited math

• hpc_links :: AnsiStyle

  the link part of hyperlinks or images

• hpc_warning :: AnsiStyle

  warning texts

• hpc_control :: AnsiStyle

  things like: equals in headers, bullets in lists, etc.

defaultHaddockConf :: HaddockPrintConf

A Good Enough colour scheme