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 /.gitlab | |
| 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 '.gitlab')
| -rwxr-xr-x | .gitlab/upload_ghc_libs.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/.gitlab/upload_ghc_libs.py b/.gitlab/upload_ghc_libs.py index f9cf7b1815..3812867148 100755 --- a/.gitlab/upload_ghc_libs.py +++ b/.gitlab/upload_ghc_libs.py @@ -135,9 +135,9 @@ def prepare_docs(bindist: Path, pkg: Package): is the path to an extract binary distribution produced by hadrian. """ - docdir = bindist / 'docs' / 'html' / 'libraries' / pkg.name cabal_file = pkg.path / f'{pkg.name}.cabal' version = get_version(cabal_file) + docdir = bindist / 'docs' / 'html' / 'libraries' / (pkg.name + "-" + version) assert version is not None # Build the documentation tarball from the bindist documentation |