-
Notifications
You must be signed in to change notification settings - Fork 697
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
Fix multi-package Haddock CSS handling #10637
base: master
Are you sure you want to change the base?
Conversation
d403468
to
f103349
Compare
Thanks! This will need a changelog file and preferably Manual QA notes (especially since it doesn’t have tests). |
f103349
to
25b141d
Compare
@ulysses4ever I have added a changelog file and QA notes. I wasn't sure whether this would be considered a significant change, but I have refrained from marking it as such unless you suggest otherwise. |
Is the failing check related to my changes, or is it a flaky test? I can't see how the changes would only cause |
That test (very rarely) fails for no obvious reason, and restarting the job generally fixes it. I've restarted it. |
Uh… not supposed to fail multiple times like that, especially for a simple change like this. |
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.
Thanks!
Fixes #10636
This PR fixes the linked issue by making the stylesheet path absolute before passing it to Haddock, and also passing the stylesheet to the index generator as well.
QA Notes
Calling
cabal haddock-project --css=<css-file>
on a multi-package project where every package has its own subdirectory (and not have their source files at the project root) should produce documentation such that:./haddocks/index.html
) is styled by the provided CSS file./haddocs/<package>/<module>.html
) styled by the provided CSS fileThis reproducer of the original issue can be used for QA purposes.
Template Α: This PR modifies behaviour or interface
Include the following checklist in your PR:
significance: significant
in the changelog file.