Script to generate standalone Haddock documentation (#55)

This commit is contained in:
Alejandro Serrano 2019-12-20 13:15:41 +01:00 committed by GitHub
parent 76df4fc022
commit 27479ab9fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 28 additions and 0 deletions

1
.gitignore vendored
View File

@ -16,3 +16,4 @@ _site
## Ruby environment normalization:
.bundle/
/docs/vendor/
docs/haddock

23
generate-haddock-docs.sh Executable file
View File

@ -0,0 +1,23 @@
#!/bin/sh
DOCSDIR=docs/haddock
echo "Installing required packages"
stack install standalone-haddock
echo "Removing previous docs"
rm -rf ${DOCSDIR}
echo "Building the project"
stack build
echo "Generating new docs"
stack exec --no-ghc-package-path standalone-haddock -- -o ${DOCSDIR} \
--compiler-exe=$(stack path --compiler-exe) \
--dist-dir=$(stack path --dist-dir) \
--package-db=$(stack path --snapshot-pkg-db) \
--package-db=$(stack path --local-pkg-db) \
core/schema core/rpc \
adapter/avro adapter/protobuf adapter/persistent \
grpc/client grpc/server \
compendium-client

4
run-docs.sh Executable file
View File

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