@@ -341,9 +341,10 @@ based on file dirtiness.
341341
342342Default: Disabled
343343
344+ The [ ` stack haddock ` ] ( haddock_command.md ) synonym sets this flag.
345+
344346Set the flag to build Haddock documentation. This may cause a lot of packages to
345- get re-built, so that the documentation links work. The ` stack haddock ` synonym
346- sets this flag.
347+ get re-built, so that the documentation links work.
347348
348349Stack applies Haddock's ` --gen-contents ` and ` --gen-index ` flags to generate a
349350single HTML contents and index for multiple sets of Haddock documentation.
@@ -363,8 +364,10 @@ single HTML contents and index for multiple sets of Haddock documentation.
363364
364365### ` --haddock-arguments ` option
365366
366- ` stack haddock --haddock-arguments <haddock_argument(s)> ` passes the specified
367- arguments to the Haddock tool.
367+ When building Haddock documentation (see the
368+ [ ` --[no-]haddock ` ] ( #-no-haddock-flag ) flag),
369+ ` --haddock-arguments <haddock_argument(s)> ` passes the specified arguments to
370+ the Haddock tool.
368371
369372Specified arguments are separated by spaces. Arguments can be unquoted (if they
370373do not contain space or ` " ` characters) or quoted (` "" ` ). Quoted arguments can
@@ -377,9 +380,11 @@ include 'escaped' characters, escaped with an initial `\` character.
377380
378381### ` --[no-]haddock-deps ` flag
379382
380- Default: Enabled (if building Haddock documnentation )
383+ Default: Enabled (if building Haddock documentation )
381384
382- Unset the flag to disable building Haddock documentation for dependencies.
385+ When building Haddock documentation (see the
386+ [ ` --[no-]haddock ` ] ( #-no-haddock-flag ) flag), unset the flag to disable building
387+ documentation for dependencies.
383388
384389### ` --[no-]haddock-for-hackage ` flag
385390
@@ -389,9 +394,10 @@ Unset the flag to disable building Haddock documentation for dependencies.
389394
390395Default: Disabled
391396
392- Set the flag to build project packages with flags to generate Haddock
393- documentation suitable for upload to Hackage. The form of the Haddock
394- documentation generated for other packages is unaffected.
397+ When building Haddock documentation (see the
398+ [ ` --[no-]haddock ` ] ( #-no-haddock-flag ) flag), set the flag to build project
399+ packages with flags to generate documentation suitable for upload to Hackage.
400+ The form of the documentation generated for other packages is unaffected.
395401
396402For each project package, the generated Haddock documentation files are in
397403directory ` doc\html\<package_version>-docs\ ` , relative to Stack's dist work
@@ -438,9 +444,11 @@ If the flag is set:
438444
439445### ` --[no-]haddock-hyperlink-source ` flag
440446
441- Default: Enabled
447+ Default: Enabled (if building Haddock documentation)
442448
443- Unset the flag to disable building building hyperlinked source for Haddock.
449+ When building Haddock documentation (see the
450+ [ ` --[no-]haddock ` ] ( #-no-haddock-flag ) flag), unset the flag to disable building
451+ documentation with hyperlinked sources.
444452
445453If the [ ` --haddock-for-hackage ` ] ( #-no-haddock-for-hackage-flag ) flag is passed,
446454this flag is ignored.
@@ -449,8 +457,9 @@ this flag is ignored.
449457
450458Default: Disabled
451459
452- Set the flag to enable building Haddock documentation for benchmark components
453- of packages.
460+ When building Haddock documentation (see the
461+ [ ` --[no-]haddock ` ] ( #-no-haddock-flag ) flag), set the flag to enable building
462+ documentation for benchmark components of packages.
454463
455464If the [ ` --haddock-for-hackage ` ] ( #-no-haddock-for-hackage-flag ) flag is passed,
456465this flag is ignored.
@@ -472,8 +481,9 @@ this flag is ignored.
472481
473482Default: Disabled
474483
475- Set the flag to enable building Haddock documentation for executable components
476- of packages.
484+ When building Haddock documentation (see the
485+ [ ` --[no-]haddock ` ] ( #-no-haddock-flag ) flag), set the flag to enable building
486+ documentation for executable components of packages.
477487
478488If the [ ` --haddock-for-hackage ` ] ( #-no-haddock-for-hackage-flag ) flag is passed,
479489this flag is ignored.
@@ -495,7 +505,9 @@ this flag is ignored.
495505
496506Default: Disabled
497507
498- Set the flag to enable building Haddock documentation for internal modules.
508+ When building Haddock documentation (see the
509+ [ ` --[no-]haddock ` ] ( #-no-haddock-flag ) flag), set the flag to enable building
510+ documentation for internal modules.
499511
500512If the [ ` --haddock-for-hackage ` ] ( #-no-haddock-for-hackage-flag ) flag is passed,
501513this flag is ignored.
@@ -504,8 +516,9 @@ this flag is ignored.
504516
505517Default: Disabled
506518
507- Set the flag to enable building Haddock documentation for test suite components
508- of packages.
519+ When building Haddock documentation (see the
520+ [ ` --[no-]haddock ` ] ( #-no-haddock-flag ) flag), set the flag to enable building
521+ documentation for test suite components of packages.
509522
510523If the [ ` --haddock-for-hackage ` ] ( #-no-haddock-for-hackage-flag ) flag is passed,
511524this flag is ignored.
0 commit comments