haskell/haddock

Name: haddock

Owner: Haskell

Description: Haskell Documentation Tool

Created: 2014-05-08 19:42:26.0

Updated: 2018-03-31 16:36:01.0

Pushed: 2018-04-02 21:42:14.0

Homepage: www.haskell.org/haddock/

Size: 13575

Language: HTML

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Haddock, a Haskell Documentation Tool

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:

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

and then proceed using your favourite build tool.

Using cabal new-build

l new-build -w ghc-8.4.1
ild & run the test suite
l new-test -w ghc-8.4.1

Using Cabal sandboxes

l sandbox init
l sandbox add-source haddock-library
l sandbox add-source haddock-api
l sandbox add-source haddock-test
just -j to the number of cores you want to use
l install -j4 --dependencies-only --enable-tests
l configure --enable-tests
l build -j4
n the test suite
rt HADDOCK_PATH="dist/build/haddock/haddock"
l test

Using Stack

k init
k install
n the test suite
rt HADDOCK_PATH="$HOME/.local/bin/haddock"
k 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.