Skip to content

Commit

Permalink
Re #5137 Improve documentation re Stack's use of Haddock flags
Browse files Browse the repository at this point in the history
  • Loading branch information
mpilgrem committed Nov 12, 2023
1 parent 8fbb815 commit fd393fd
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions doc/build_command.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,9 @@ Set the flag to build Haddock documentation. This may cause a lot of packages to
get re-built, so that the documentation links work. The `stack haddock` synonym
sets this flag.

Stack applies Haddock's `--gen-contents` and `--gen-index` flags to generate a
single HTML contents and index for multiple sets of Haddock documentation.

### `--haddock-arguments` option

`stack haddock --haddock-arguments <haddock_argument(s)>` passes the specified
Expand All @@ -232,6 +235,11 @@ Specified arguments are separated by spaces. Arguments can be unquoted (if they
do not contain space or `"` characters) or quoted (`""`). Quoted arguments can
include 'escaped' characters, escaped with an initial `\` character.

!!! note

Haddock's `--latex` flag is incompatible with the Haddock flags used by
Stack to generate a single HTML contents and index.

### `--[no-]haddock-deps` flag

Default: Enabled (if building Haddock documnentation)
Expand Down

0 comments on commit fd393fd

Please sign in to comment.