haskell / haskell/cabal

Generate haddock for multiple (sub)libraries at once

Open
#9,577 2 comments 1 reaction 0 assignees View on GitHub
type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

Currently, running `cabal haddock --haddock-for-hackage` seems to produce a tarball containing the docs for one library.

If you pass it the name of a sublibrary, it will generate the docs for that sublibrary only.

Hackage seems to overwrite the docs when you upload a new tarball, so it seems people would need to either fiddle with tarballs manually, or have only one library documented.

Note that when [this change](https://github.com/haskell/hackage-server/pull/1279) is deployed, hackage will list the modules of multiple libraries, so a lack of docs will become quite visible.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.