Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing hyperlinks to types and functions in external packages (Haddock on Hackage). #1364

Open
jonathanknowles opened this issue Feb 27, 2025 · 0 comments

Comments

@jonathanknowles
Copy link

jonathanknowles commented Feb 27, 2025

When Hackage generates Haddock documentation for monoidmap-aeson, it:

  • successfully generates hyperlinks to types and functions in packages such as aeson and monoid-subclasses.
  • but fails to generate hyperlinks to types and functions from the monoidmap package.

Logs and debugging

Is it possible to inspect logs for haddock generation on hackage? I can see logs here, but can't see an obvious cause for the hyperlink failure. (Though perhaps I'm looking in the wrong place?)

Versions

This has happened for all of the following versions:

I initially assumed that there must be something broken in the monoidmap-aeson package.

However, when I run cabal haddock locally on the same source code, or as part of CI (which uses Haddock version 2.30.0), everything works as expected, and all hyperlinks are generated successfully. 🤷🏻

Expected behaviour

Documentation built by GitHub actions (link) (Haddock version 2.30.0):

Image

Note that symbols like MonoidMap and fromList are successfully hyperlinked.

Actual behaviour

Documentation built on Hackage (link):

Image

Note that symbols like ToJSON, encode, and Sum are hyperlinked, but MonoidMap and fromList are not, and yet both of these are exported from the Data.MonoidMap module, as already published on hackage (see monoidmap:Data.MonoidMap).

Workarounds

I know it's possible to upload documentation manually, but I'd like to figure out if there's something I'm doing wrong that is preventing Hackage from successfully generating hyperlinks to monoidmap.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant