Skip to content

Commit cbf8b7a

Browse files
authored
Model workflow: pass --disable-documentation to cabal haddock (#109)
Closes #107.
1 parent bbd90a2 commit cbf8b7a

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,9 +200,16 @@ jobs:
200200
run: cabal check
201201

202202
- name: Build documentation
203-
run: cabal haddock all
203+
run:
204+
cabal haddock all --disable-documentation
205+
# --disable-documentation disables building documentation for dependencies.
206+
# The package's own documentation is still built,
207+
# yet contains no links to the documentation of the dependencies.
204208
```
205209

210+
Alternatively, the two occurrences of `--disable-documentation` can be changed to `--enable-documentation`, for resolving the external references to the documentation of the dependencies.
211+
This will increase build times a bit, though.
212+
206213
## Inputs
207214

208215
| Name | Description | Type | Default |

0 commit comments

Comments
 (0)