diff options
| author | Matthew Pickering <matthewtpickering@gmail.com> | 2022-06-27 22:42:28 +0100 |
|---|---|---|
| committer | Marge Bot <ben+marge-bot@smart-cactus.org> | 2022-07-04 17:56:30 -0400 |
| commit | d002c6e04f0c0f26c3ee24661eb4cf5620f994ab (patch) | |
| tree | 3b1a07e23ee41617c8e9fbe71f68271927853d6e /hadrian/hadrian.cabal | |
| parent | ed793d7a5725689bf1f3c81ce3d7958ccaf60e7e (diff) | |
| download | haskell-d002c6e04f0c0f26c3ee24661eb4cf5620f994ab.tar.gz | |
hadrian: Add --haddock-base-url option for specifying base-url when generating docs
The motiviation for this flag is to be able to produce documentation
which is suitable for uploading for hackage, ie, the cross-package links
work correctly.
There are basically three values you want to set this to:
* off - default, base_url = ../%pkg% which works for local browsing
* on - no argument , base_url = https:://hackage.haskell.org/package/%pkg%/docs - for hackage docs upload
* on - argument, for example, base_url = http://localhost:8080/package/%pkg%/docs for testing the documentation.
The `%pkg%` string is a template variable which is replaced with the
package identifier for the relevant package.
This is one step towards fixing #21749
Diffstat (limited to 'hadrian/hadrian.cabal')
| -rw-r--r-- | hadrian/hadrian.cabal | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/hadrian/hadrian.cabal b/hadrian/hadrian.cabal index 7ddacb4b9b..da0aa4daab 100644 --- a/hadrian/hadrian.cabal +++ b/hadrian/hadrian.cabal @@ -153,6 +153,7 @@ executable hadrian , shake >= 0.18.3 && < 0.20 , transformers >= 0.4 && < 0.6 , unordered-containers >= 0.2.1 && < 0.3 + , text >= 1.2 && < 3 ghc-options: -Wall -Wincomplete-record-updates -Wredundant-constraints |