Skip to content
This repository was archived by the owner on Oct 19, 2024. It is now read-only.

Commit 27479ab

Browse files
authored
Script to generate standalone Haddock documentation (#55)
1 parent 76df4fc commit 27479ab

File tree

3 files changed

+28
-0
lines changed

3 files changed

+28
-0
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,4 @@ _site
1616
## Ruby environment normalization:
1717
.bundle/
1818
/docs/vendor/
19+
docs/haddock

generate-haddock-docs.sh

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#!/bin/sh
2+
3+
DOCSDIR=docs/haddock
4+
5+
echo "Installing required packages"
6+
stack install standalone-haddock
7+
8+
echo "Removing previous docs"
9+
rm -rf ${DOCSDIR}
10+
11+
echo "Building the project"
12+
stack build
13+
14+
echo "Generating new docs"
15+
stack exec --no-ghc-package-path standalone-haddock -- -o ${DOCSDIR} \
16+
--compiler-exe=$(stack path --compiler-exe) \
17+
--dist-dir=$(stack path --dist-dir) \
18+
--package-db=$(stack path --snapshot-pkg-db) \
19+
--package-db=$(stack path --local-pkg-db) \
20+
core/schema core/rpc \
21+
adapter/avro adapter/protobuf adapter/persistent \
22+
grpc/client grpc/server \
23+
compendium-client

run-docs.sh

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/sh
2+
3+
bundle install --gemfile docs/Gemfile --path vendor/bundle
4+
BUNDLE_GEMFILE=./docs/Gemfile bundle exec jekyll serve -s docs -b /mu-haskell

0 commit comments

Comments
 (0)