search

well-typed / optics

Optics as an abstract interface
374 stars 24 forks source link

haddock bundle script #465

Closed phadej closed 1 year ago

adamgundry commented 2 years ago

Nice! Thanks for looking into this. I haven't looked extremely closely at the code, but the results on https://hackage.haskell.org/package/optics look good. :smile:

Did you manage to resolve the issue with there being a few missing links?

We should remove the note from the description saying "Hackage does not yet display documentation for reexported-modules".

Fixes #237.

arybczak commented 2 years ago

While this looks great, it seems that modules from optics-extra are missing links :disappointed:

arybczak commented 2 years ago

I wonder if providing dummy files that redirect to modules in appropriate package with <meta http-equiv="refresh" content="0; url=...> would work :thinking:

The other problem is that if you generate documentation locally, you lose links to all packages that are not available.

phadej commented 2 years ago

Did you manage to resolve the issue with there being a few missing links?

No, that seems to be some issue with haddock, i have no idea what it could be.

phadej commented 1 year ago

Can this be merged before it bitrots? AFAIU the issues are unfortunately caused by difference between v2-haddock and how hackage's doc builder builds docs, and fixing that would need either fixing cabal-install (and haddock?) or changing the approach completely.

phadej commented 1 year ago

I added a commit which seems to fix links from optics-extra packages

adamgundry commented 1 year ago

Nice work tracking that down! And sorry for letting this linger, let's get it merged. I'm assuming you already uploaded docs to Hackage, since I see them published...

I think we should:

phadej commented 1 year ago

can one do that directly with cabal upload -d

I don't know, never used that one.

Briefly document the release process somewhere.

Once someone does it, they could write a trace of what they did.