Mirror of haddock repository. DO NOT SUBMIT PULL REQUESTS HERE. Use http://github.com/haskell/haddock instead!
HTML Haskell CSS TypeScript JavaScript TeX Other
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc Fix tiny typo in docs (#693) Oct 24, 2017
driver-test The Haddock part for fully gcc-like response files Jan 2, 2016
driver The Haddock part for fully gcc-like response files Jan 2, 2016
haddock-api Use the GHC lexer for the Hyperlinker backend (#714) Dec 10, 2017
haddock-library Refactoring: Make doc renaming monadic Aug 16, 2017
haddock-test Fix test failures on Windows (#564) Jul 3, 2017
hoogle-test Fix test failures on Windows (#564) Jul 3, 2017
html-test Fix #548 by rendering datatype kinds more carefully (#702) Nov 14, 2017
hypsrc-test Use the GHC lexer for the Hyperlinker backend (#714) Dec 10, 2017
latex-test Fix test failures on Windows (#564) Jul 3, 2017
scripts Move dist scripts to scripts/ Apr 11, 2017
.arcconfig Add an .arcconfig file. Dec 12, 2014
.arclint Add .arclint file. Dec 12, 2014
.ghci Move sources under haddock-api/src Aug 23, 2014
.gitignore Fix #548 by rendering datatype kinds more carefully (#702) Nov 14, 2017
.travis.yml Use travis_retry for cabal invocations Apr 25, 2017
CHANGES.md Use the GHC lexer for the Hyperlinker backend (#714) Dec 10, 2017
CONTRIBUTING CONTRIBUTING file for issues Sep 3, 2014
LICENSE Move Haddock API to a separate package Aug 22, 2014
Makefile Update Makefile for the new GHC build system Jul 5, 2009
README.md Update README Jul 20, 2017
STYLE Add a pointer to the style guide Oct 17, 2010
Setup.lhs Fix Setup.lhs Oct 15, 2012
cabal.project Add haddock to cabal.project Apr 11, 2017
ghc.mk ghc.mk: Don't attempt to install html/frames.html Aug 7, 2016
haddock.cabal Declare use of `Paths_haddock` module in other-modules (#705) Nov 20, 2017
haddock.wrapper GHC build system: Make *nix installation work in paths containing spaces Nov 5, 2009

README.md

Haddock, a Haskell Documentation Tool Build Status

About haddock

See Description on Hackage.

Source code documentation

Full documentation can be found in the doc/ subdirectory, in reStructedText format format.

Contributing

Please create issues when you have any problems and pull requests if you have some code.

Hacking

To get started you'll need a latest GHC release installed.

Clone the repository:

  git clone https://github.com/haskell/haddock.git
  cd haddock

and then proceed using your favourite build tool.

Using cabal new-build

cabal new-build -w ghc-8.2.1
# build & run the test suite
cabal new-test -w ghc-8.2.1

Using Cabal sandboxes

cabal sandbox init
cabal sandbox add-source haddock-library
cabal sandbox add-source haddock-api
cabal sandbox add-source haddock-test
# adjust -j to the number of cores you want to use
cabal install -j4 --dependencies-only --enable-tests
cabal configure --enable-tests
cabal build -j4
# run the test suite
export HADDOCK_PATH="dist/build/haddock/haddock"
cabal test

Using Stack

stack init
stack install
# run the test suite
export HADDOCK_PATH="$HOME/.local/bin/haddock"
stack test

Git Branches

If you're a GHC developer and want to update Haddock to work with your changes, you should be working on ghc-head branch instead of master. See instructions at https://ghc.haskell.org/trac/ghc/wiki/WorkingConventions/Git/Submodules for an example workflow.

The master branch usually requires a GHC from the latest GHC stable branch. The required GHC version can be inferred from the version bounds on ghc in the respective .cabal files.