haskell / haskell/cabal

Flag to upload to auto-build and upload docs as well

Open
#8,249 2 comments 3 reactions 0 assignees View on GitHub
attention: pr-welcome cabal-install: cmd/haddock cabal-install: cmd/sdist cabal-install: cmd/upload type: enhancement
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

Suggested by chris martin in this thread: https://discourse.haskell.org/t/on-onboarding-hackage-missing-documentation/4684/4

```
dir=$(mktemp -d dist-docs.XXXXXX)
cabal configure --builddir="$dir"
cabal haddock --builddir="$dir" --haddock-for-hackage --haddock-option=--hyperlinked-source
cabal upload --publish -d $dir/*-docs.tar.gz
```

Generally an all in one workflow to sdist, haddock, and upload both would be very nice and probably improve the docs situation on hackage.

Related discussions: https://github.com/haskell/cabal/issues/5064 https://github.com/haskell/cabal/issues/7566 and https://github.com/haskell/cabal/issues/3837

The latter is arguably the most comprehensive and may subsume this.

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.