Haddock documentation not yet viewable on Hackage. - Githubissues

IntersectMBO / cardano-transactions

Library utilities for constructing and signing Cardano transactions.

Apache License 2.0

25 stars 7 forks source link

Haddock documentation not yet viewable on Hackage. #11

Open jonathanknowles opened 4 years ago

jonathanknowles commented 4 years ago

Reproduction Steps

View the cardano-transactions library on Hackage: https://hackage.haskell.org/package/cardano-transactions
Navigate to the "Modules" section header.
Attempt to view the documentation for a module within the package. For example: Data.UTxO.Transaction.

Expected Behaviour

Each module name is a link that, when followed, leads to the documentation for that module. :link:

Actual Behaviour

The module names do not link to documentation.

Possible Causes

Hackage appears to be unable to build the package: https://hackage.haskell.org/package/cardano-transactions-1.0.0/reports/

(Presumably because of other library dependencies from the Cardano ecosystem that are not yet on Hackage.)

Relevance

Being able to view the documentation on Hackage would be useful, since:

the version of the documentation linked to in the README corresponds to the latest commit to master.
users of the library may want to refer to older versions of the documentation (not yet relevant, but will become so if/when new versions are released).

jonathanknowles commented 4 years ago

It's possible to upload documentation manually (after the fact) by using the cabal upload command. See this page for more details:

https://hackage.haskell.org/upload