diff options
Diffstat (limited to 'platform/macos/scripts/document.sh')
-rwxr-xr-x | platform/macos/scripts/document.sh | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/platform/macos/scripts/document.sh b/platform/macos/scripts/document.sh new file mode 100755 index 0000000000..e62a1e1668 --- /dev/null +++ b/platform/macos/scripts/document.sh @@ -0,0 +1,45 @@ +#!/usr/bin/env bash + +set -e +set -o pipefail +set -u + +if [ -z `which jazzy` ]; then + echo "Installing jazzy…" + gem install jazzy + if [ -z `which jazzy` ]; then + echo "Unable to install jazzy. See https://github.com/mapbox/mapbox-gl-native/blob/master/platform/macos/INSTALL.md" + exit 1 + fi +fi + +OUTPUT=${OUTPUT:-documentation} + +BRANCH=$( git describe --tags --match=macos-v*.*.* --abbrev=0 ) +SHORT_VERSION=$( echo ${BRANCH} | sed 's/^macos-v//' ) +RELEASE_VERSION=$( echo ${SHORT_VERSION} | sed -e 's/^macos-v//' -e 's/-.*//' ) + +SWIFT_VERSION=$(xcrun swift -version | head -n 1 | sed -e 's/^Apple Swift version //' -e 's/ .*$//') + +rm -rf /tmp/mbgl +mkdir -p /tmp/mbgl/ +README=/tmp/mbgl/README.md +cp platform/macos/docs/doc-README.md "${README}" +# http://stackoverflow.com/a/4858011/4585461 +echo "## Changes in version ${RELEASE_VERSION}" >> "${README}" +sed -n -e '/^## /{' -e ':a' -e 'n' -e '/^##/q' -e 'p' -e 'ba' -e '}' platform/macos/CHANGELOG.md >> "${README}" + +rm -rf ${OUTPUT} +mkdir -p ${OUTPUT} + +jazzy \ + --config platform/macos/jazzy.yml \ + --sdk macosx \ + --swift-version $SWIFT_VERSION \ + --github-file-prefix https://github.com/mapbox/mapbox-gl-native/tree/${BRANCH} \ + --module-version ${SHORT_VERSION} \ + --readme ${README} \ + --output ${OUTPUT} +# https://github.com/realm/jazzy/issues/411 +find ${OUTPUT} -name *.html -exec \ + perl -pi -e 's/Mapbox\s+(Docs|Reference)/Mapbox macOS SDK $1/' {} \; |