add HTML docs generation to iOS packaging script
This commit is contained in:
@@ -48,8 +48,8 @@ Target OS X: 10.9+
|
||||
|
||||
If you merely want to install the library for iOS and try it out as an Objective-C consumer:
|
||||
|
||||
0. Use [Homebrew](http://brew.sh/) to install Boost headers: `brew install boost`.
|
||||
1. Run `make ipackage`. The packaging script will produce the statically-linked `libMapboxGL.a`, `MapboxGL.bundle` for resources, and a `Headers` folder.
|
||||
0. Use [Homebrew](http://brew.sh/) to install Boost headers and [appledoc](http://gentlebytes.com/appledoc/): `brew install boost appledoc`.
|
||||
1. Run `make ipackage`. The packaging script will produce the statically-linked `libMapboxGL.a`, `MapboxGL.bundle` for resources, a `Headers` folder, and a `Docs` folder with HTML API documentation.
|
||||
2. Copy the contents of `build/ios/pkg/static` into your project. It should happen automatically, but ensure that:
|
||||
- `Headers` is in your *Header Search Paths* (`HEADER_SEARCH_PATHS`) build setting.
|
||||
- `MapboxGL.bundle` is in your target's *Copy Bundle Resources* build phase.
|
||||
|
||||
@@ -92,3 +92,23 @@ cp -pv LICENSE.md "${OUTPUT}/static"
|
||||
mkdir -p "${OUTPUT}/static/${NAME}.bundle"
|
||||
cp -pv platform/ios/resources/* "${OUTPUT}/static/${NAME}.bundle"
|
||||
cp -prv styles/styles "${OUTPUT}/static/${NAME}.bundle/styles"
|
||||
|
||||
step "Creating API Docs..."
|
||||
if [ -z `which appledoc` ]; then
|
||||
echo "Unable to find appledoc. Consider installing it from source or Homebrew."
|
||||
exit 1
|
||||
fi
|
||||
DOCS_OUTPUT="${OUTPUT}/static/Docs"
|
||||
DOCS_VERSION=$( git tag -l ios\* --sort -v:refname | sed -n '1p' | sed 's/ios-v//' )
|
||||
appledoc \
|
||||
--output ${DOCS_OUTPUT} \
|
||||
--project-name "Mapbox GL for iOS ${DOCS_VERSION}" \
|
||||
--project-company Mapbox \
|
||||
--create-html \
|
||||
--no-create-docset \
|
||||
--no-install-docset \
|
||||
--company-id com.mapbox \
|
||||
include/mbgl/ios
|
||||
cd ${DOCS_OUTPUT}
|
||||
ln -s html/index.html
|
||||
cd ${OLDPWD}
|
||||
|
||||
Reference in New Issue
Block a user