diff options
author | Justin R. Miller <incanus@codesorcery.net> | 2015-05-11 13:01:09 -0700 |
---|---|---|
committer | Justin R. Miller <incanus@codesorcery.net> | 2015-05-11 13:01:09 -0700 |
commit | 834e59722c81de924fbcabc3e800c81da4a53405 (patch) | |
tree | a4218fcdf11317ad6d10d0a96ac1ce7d412add5e | |
parent | 9ac29c6e44a02723ba645ea43500e176c1a81532 (diff) | |
download | qtlocation-mapboxgl-834e59722c81de924fbcabc3e800c81da4a53405.tar.gz |
fixes #1503: add changelog w/ notes to appledoc index
-rw-r--r-- | ios/README.md | 5 | ||||
-rwxr-xr-x | ios/docs/install_docs.sh | 15 | ||||
-rwxr-xr-x | ios/docs/remove_docs.sh | 2 | ||||
-rwxr-xr-x | scripts/ios/package.sh | 7 |
4 files changed, 24 insertions, 5 deletions
diff --git a/ios/README.md b/ios/README.md new file mode 100644 index 0000000000..169da5ff89 --- /dev/null +++ b/ios/README.md @@ -0,0 +1,5 @@ +# Mapbox GL for iOS + +An open source OpenGL-based vector map solution for iOS with full styling capabilities and Cocoa bindings. + +For more information, check out [our online overview](https://www.mapbox.com/mapbox-gl-ios/). 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..." diff --git a/scripts/ios/package.sh b/scripts/ios/package.sh index 675e31d573..35162ce5d1 100755 --- a/scripts/ios/package.sh +++ b/scripts/ios/package.sh @@ -103,6 +103,11 @@ if [ -z `which appledoc` ]; then fi DOCS_OUTPUT="${OUTPUT}/static/Docs" DOCS_VERSION=$( git tag -l ios\* --sort -v:refname | sed -n '1p' | sed 's/ios-v//' ) +README="/tmp/GL-README.md" +cat ios/README.md > ${README} +echo >> ${README} +echo -n "#" >> ${README} +cat CHANGELOG.md >> ${README} appledoc \ --output ${DOCS_OUTPUT} \ --project-name "Mapbox GL for iOS ${DOCS_VERSION}" \ @@ -111,4 +116,6 @@ appledoc \ --no-create-docset \ --no-install-docset \ --company-id com.mapbox \ + --ignore include/mbgl/ios/private \ + --index-desc ${README} \ include/mbgl/ios |