Commit 0a97adf9 authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Added bash script to generate docs from SDK.

That's the script I'm currently using for development.

Added bunch of comments of why certain command line options are passed.
parent 9ddde67f
Loading
Loading
Loading
Loading

sdk.sh

0 → 100755
+29 −0
Original line number Diff line number Diff line
#/usr/bin/env bash

# The Bash script I'm currently using to generate documentation from
# latest ExtJS SDK.

# Sorry, these are currently hard-coded :(
SDK_DIR=~/work/SDK
OUT_DIR=~/public_html/docs

ruby bin/jsduck \
     --template-links \
     --external=Error \
     --link='<a href="#/api/%c" rel="%c%M" class="docClass">%a</a>' \
     --img='<p><img src="doc-resources/%u" alt="%a"></p>' \
     --output=$OUT_DIR \
     $SDK_DIR/extjs/src $SDK_DIR/platform/src $SDK_DIR/platform/core/src

# --template-links to create symbolic links to template files instead
# of copying them over.  Useful for development.  Turn off for
# deployment.

# --external=Error to ignore the Error class that Ext.Error extends.

# Note that we wrap image template inside <p> because {@img} often
# appears inline withing text, but that just looks ugly in HTML

# Finally copy over the images that documentation links to.
cp -r $SDK_DIR/extjs/doc-resources $SDK_DIR/doc-resources