-
Notifications
You must be signed in to change notification settings - Fork 24
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
haddock bundle script #465
Conversation
This is an initial experiment. It works quite well, but it could be better. - Links to identifiers in different packages go outside of optics (e.g. from optics-extra modules to optics-core to https://hackage.haskell.org/package/optics-0.4.2/docs/Optics-Indexed.html) but the links which are internal to package stay there.
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. 😄 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. |
While this looks great, it seems that modules from |
I wonder if providing dummy files that redirect to modules in appropriate package with The other problem is that if you generate documentation locally, you lose links to all packages that are not available. |
No, that seems to be some issue with |
Can this be merged before it bitrots? AFAIU the issues are unfortunately caused by difference between |
@@ -0,0 +1,38 @@ | |||
#!/bin/sh | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add a brief "Usage" section? Even if it's running it without any arguments.
I added a commit which seems to fix links from |
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:
|
I don't know, never used that one.
Once someone does it, they could write a trace of what they did. |
No description provided.