haskell / haddock

Haskell Documentation Tool

Home Page:www.haskell.org/haddock/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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.

About

Haskell Documentation Tool

www.haskell.org/haddock/

License:BSD 2-Clause "Simplified" License


Languages

Language:HTML 55.0%Language:Haskell 39.4%Language:CSS 2.5%Language:TypeScript 1.8%Language:TeX 0.8%Language:JavaScript 0.3%Language:Makefile 0.2%Language:Shell 0.1%Language:C 0.0%