haskell / haskell/cabal

How to upload haddocks to Hackage?

Open
#5,821 8 comments 0 reactions 0 assignees View on GitHub
cabal-install: cmd/haddock cabal-install: cmd/upload documentation type: enhancement type: user-question
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

This doesn't seem to be documented anywhere, but implicit in the help messages for upload. WHere do i look to find this information?

**UPD (2025):**

This is currently documented at the bottom of https://hackage.haskell.org/upload, and, in its simplified form, looks as follows:

```
$ cabal haddock --enable-doc --haddock-for-hackage
$ cabal upload --documentation ./dist-newstyle/*-docs.tar.gz
```

Contributor guide

Open the contributing guide

Research direction

Start with the upload help messages referenced in the issue and compare them with the documentation currently shown at https://hackage.haskell.org/upload. Confirm the documented cabal haddock and cabal upload workflow, then identify the appropriate Cabal documentation location; done means a newcomer can find and follow the complete process.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.