# \[Resolved\] What steps are needed to upload docs to hackage?

**URL:** <https://discourse.haskell.org/t/resolved-what-steps-are-needed-to-upload-docs-to-hackage/4575>\
**Category:** Learn\
**Created:** [May 23, 2022, 5:24pm UTC](https://discourse.haskell.org/t/resolved-what-steps-are-needed-to-upload-docs-to-hackage/4575 "2022-05-23T17:24:13Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![DiscoDev](https://sea2.discourse-cdn.com/flex002/user_avatar/discourse.haskell.org/discodev/32/1619_2.png) [@DiscoDev](https://discourse.haskell.org/u/DiscoDev)\
**Post date:** [May 23, 2022, 5:24pm UTC](https://discourse.haskell.org/t/resolved-what-steps-are-needed-to-upload-docs-to-hackage/4575/1 "2022-05-23T17:24:13Z")

</div>

Hello,

I’ve been trying to figure out what combination of commands I need to properly upload documentation to hackage that includes working hyperlinks.

So far I have tried translating this script from lens, [lens/hackage-docs.sh at master · ekmett/lens · GitHub](https://github.com/ekmett/lens/blob/master/scripts/hackage-docs.sh), into a github work flow, [message-db/ci.yaml at 4b9eb68b9b46d48df5dc012a1de8947b29599100 · Disco-Dave/message-db · GitHub](https://github.com/Disco-Dave/message-db/blob/4b9eb68b9b46d48df5dc012a1de8947b29599100/.github/workflows/ci.yaml#L81).

However when viewing the release candidate on hackage some of the links are missing, for instance anything from `postgresql-simple` does not get hyperlinked in the type signatures. [MessageDb.Functions](https://hackage.haskell.org/package/message-db-0.1.0.0/candidate/docs/MessageDb-Functions.html)

Can anyone tell me what I’m doing wrong or point me to up to date information on how to properly publish a package with hyperlinked documentation?

Thanks,  
David

Resolution:  
I should have read the official docs better. The answer was at the bottom of the page on [Uploading packages and package candidates | Hackage](https://hackage.haskell.org/upload).

In particular I just needed to change from:

```haskell
cabal haddock --builddir ./hackage-dist --haddock-for-hackage --haddock-options=--hyperlinked-source

```

to

```haskell
cabal haddock --builddir ./hackage-dist --haddock-for-hackage --enable-doc

```

---

<div class="post-metadata">

**Author:** ![mpickering](https://sea2.discourse-cdn.com/flex002/user_avatar/discourse.haskell.org/mpickering/32/4585_2.png) [@mpickering](https://discourse.haskell.org/u/mpickering)\
**Post date:** [February 21, 2025, 10:00am UTC](https://discourse.haskell.org/t/resolved-what-steps-are-needed-to-upload-docs-to-hackage/4575/2 "2025-02-21T10:00:14Z")

</div>

Split this topic on February 21, 2025, 10:00am UTC

A post was split to a new topic: [Problem with creating docs with cabal-install-3.14.1.0](https://discourse.haskell.org/t/problem-with-creating-docs-with-cabal-install-3-14-1-0/11464)