Skip to content

Commit

Permalink
Model workflow: pass --disable-documentation to cabal haddock (#109)
Browse files Browse the repository at this point in the history
Closes #107.
  • Loading branch information
andreasabel authored Jan 13, 2025
1 parent bbd90a2 commit cbf8b7a
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,9 +200,16 @@ jobs:
run: cabal check

- name: Build documentation
run: cabal haddock all
run:
cabal haddock all --disable-documentation
# --disable-documentation disables building documentation for dependencies.
# The package's own documentation is still built,
# yet contains no links to the documentation of the dependencies.
```

Alternatively, the two occurrences of `--disable-documentation` can be changed to `--enable-documentation`, for resolving the external references to the documentation of the dependencies.
This will increase build times a bit, though.

## Inputs

| Name | Description | Type | Default |
Expand Down

0 comments on commit cbf8b7a

Please sign in to comment.