summaryrefslogtreecommitdiff
path: root/ios/docs
diff options
context:
space:
mode:
authorJustin R. Miller <incanus@codesorcery.net>2015-05-11 13:01:09 -0700
committerJustin R. Miller <incanus@codesorcery.net>2015-05-11 13:01:09 -0700
commit834e59722c81de924fbcabc3e800c81da4a53405 (patch)
treea4218fcdf11317ad6d10d0a96ac1ce7d412add5e /ios/docs
parent9ac29c6e44a02723ba645ea43500e176c1a81532 (diff)
downloadqtlocation-mapboxgl-834e59722c81de924fbcabc3e800c81da4a53405.tar.gz
fixes #1503: add changelog w/ notes to appledoc index
Diffstat (limited to 'ios/docs')
-rwxr-xr-xios/docs/install_docs.sh15
-rwxr-xr-xios/docs/remove_docs.sh2
2 files changed, 12 insertions, 5 deletions
diff --git a/ios/docs/install_docs.sh b/ios/docs/install_docs.sh
index df1d366e6a..7d4bf279f3 100755
--- a/ios/docs/install_docs.sh
+++ b/ios/docs/install_docs.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env bash
if [ -z `which appledoc` ]; then
echo "Unable to find appledoc. Consider installing it from source or Homebrew."
@@ -8,14 +8,21 @@ fi
OUTPUT="/tmp/`uuidgen`"
VERSION=$( git tag -l ios\* --sort -v:refname | sed -n '1p' | sed 's/ios-v//' )
-echo "Creating new docs for $VERSION..."
+echo "Creating new docs for ${VERSION}..."
echo
+README="/tmp/GL-README.md"
+cat ../README.md > ${README}
+echo >> ${README}
+echo -n "#" >> ${README}
+cat ../../CHANGELOG.md >> ${README}
+
appledoc \
- --output $OUTPUT \
- --project-name "Mapbox GL for iOS $VERSION" \
+ --output ${OUTPUT} \
+ --project-name "Mapbox GL for iOS ${VERSION}" \
--project-company Mapbox \
--create-docset \
--company-id com.mapbox \
--ignore ../../include/mbgl/ios/private \
+ --index-desc ${README} \
../../include/mbgl/ios
diff --git a/ios/docs/remove_docs.sh b/ios/docs/remove_docs.sh
index 09e2c1d399..747ca0a3ae 100755
--- a/ios/docs/remove_docs.sh
+++ b/ios/docs/remove_docs.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env bash
echo
echo "Removing docs from ~/Library/Developer/Shared/Documentation/DocSets..."