You are here

How to build the SDK docs (Mac OS X only)

The SkyVault Appcelerator docs can be built on Mac OS X, or simply downloaded pre-built from the SkyVault GitHub page.
To build the API documentation yourself you require the SkyVault Appcelerator SDK source code. The SkyVault Appcelerator SDK source code can be obtained from the SkyVault GitHub page. See How to obtain the source code for further details.
Note: It is not a requirement that you build the documentation yourself, although that may be convenient. The documentation is available prebuilt in both HTML and DocSet format from the project releases page.
Note: If you are on Microsoft Windows and are interested only in building applications for Android devices, then you should download the API documentation in HTML format from the project release page on GitHub.
In the root of your SkyVault Appcelerator SDK source code tree run the script ./build_appledoc.sh.
The documentation will be built in HTML and DocSet format into the SkyVaultAppceleratorSDKHelp directory.
You have now successfully built the SkyVault Appcelerator SDK API documentation.