Skip to content

Commit

Permalink
Fix haddock publishing
Browse files Browse the repository at this point in the history
  • Loading branch information
newhoggy committed Jan 13, 2021
1 parent 4b767d2 commit 4869d1d
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/github-page.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
echo "CABAL_BUILDDIR=$CABAL_BUILDDIR" >> $GITHUB_ENV
- name: Set cache version
run: echo "CACHE_VERSION=myfzgX7" >> $GITHUB_ENV
run: echo "CACHE_VERSION=usE8bDW" >> $GITHUB_ENV

- name: Add build script path
run: echo "$(pwd)/.github/bin" >> $GITHUB_PATH
Expand Down
19 changes: 15 additions & 4 deletions scripts/haddocs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,22 @@ HADDOCK_OPTS=(
--haddock-hyperlink-source
--haddock-option "--show-all"
--haddock-option "--use-unicode"
--haddock-option "--use-contents=\"../index.html\""
--disable-tests
)

# build documentation of all modules
if [ ${REGENERATE} == "true" ]; then
cabal haddock "${HADDOCK_OPTS[@]}" cardano-api
cabal haddock "${HADDOCK_OPTS[@]}" \
cardano-api \
cardano-api-test \
cardano-cli \
cardano-config \
cardano-node \
hedgehog-extras \
exe:cardano-cli \
exe:cardano-node \
exe:cardano-node-chairman \
exe:cardano-testnet
elif [ ${REGENERATE} != "false" ]; then
cabal haddock "${HADDOCK_OPTS[@]}" ${REGENERATE}
fi
Expand All @@ -67,7 +77,9 @@ done
# --read-interface options
interface_options () {
for package in $(ls "${OUTPUT_DIR}"); do
echo "--read-interface=${package},${OUTPUT_DIR}/${package}/${package}.haddock"
if [ -f "${OUTPUT_DIR}/${package}/${package}.haddock" ]; then
echo "--read-interface=${package},${OUTPUT_DIR}/${package}/${package}.haddock"
fi
done
}

Expand All @@ -80,7 +92,6 @@ haddock \
--gen-index \
--gen-contents \
--quickjump \
--prolog ./scripts/prolog \
$(interface_options)

# Assemble a toplevel `doc-index.json` from package level ones.
Expand Down
12 changes: 10 additions & 2 deletions scripts/prolog
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

[skip to module list](#module-list)

This site contains Haskell documentation of
This site contains Haskell documentation of:

* __[Cardano API](cardano-api/Cardano-API.html)__
* __[Cardano Api ](cardano-api/doc-index.html)__
* __[Cardano Api-test ](cardano-api-test/doc-index.html)__
* __[Cardano Cli ](cardano-cli/doc-index.html)__
* __[Cardano Config ](cardano-config/doc-index.html)__
* __[Cardano Node ](cardano-node/doc-index.html)__
* __[Cardano Node ](cardano-node/doc-index.html)__
* __[Cardano Node-chairman ](cardano-node-chairman/doc-index.html)__
* __[Cardano Testnet ](cardano-testnet/doc-index.html)__
* __[Hedgehog Extras ](hedgehog-extras/doc-index.html)__

0 comments on commit 4869d1d

Please sign in to comment.