Skip to content
Snippets Groups Projects
Select Git revision
20 results
Compare
user avatar
Clean-up of Interface and Interface.Create's imports part 2
Hécate Moonlight authored
4289b9ce
History
user avatar 4289b9ce
History
Name Last commit Last update
.github/workflows
doc
driver
haddock-api
haddock-library
haddock-test
hoogle-test
html-test
hypsrc-test
latex-test
.gitignore
CHANGES.md
CONTRIBUTING.md
LICENSE
Makefile
README.md
Setup.lhs
cabal.project
ghc.mk
haddock.cabal
haddock.wrapper
README.md

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 reStructedText format 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.