Add .doc derivation to test components #1982
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Haddocks are built with --tests if we are in a test component.
Haddock will generate a <componentName>/ directory within this path automatically. So a package with name "foo" and test suite "bar" will have docdir paths: $doc/share/doc/foo/html/index.html # library haddocks $doc/share/doc/foo/html/bar/index.html # bar test suite haddocks
Makes the cleanup step search more liberally for .html files to remove references from. This is needed because test suite haddocks are placed in a <package-name>/html/<test suite name>/ subdirectory.
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a
.docas it is available on<package>.components.library.docalso to test components<package>.components.tests.<test>.doc, for example https://github.com/input-output-hk/hydra/blob/77c612f2540bcca6cc43ca5c6c7094e35f0edd12/flake.nix#L53.The output paths follow a similar pattern as
cabal-installwould produce (despite the fact that it puts things into completely different prefixes) and are easily combinable as also seen in the above link. For example a package with name "foo" and test suite "bar" willhave output paths:
$doc/share/doc/foo/html/index.html # library haddocks
$doc/share/doc/foo/html/bar/index.html # bar test suite haddocks