Merge pull request watson-developer-cloud#180 from watson-developer-cloud/jsdoc

Automatically generate docs

Author: nfriedly

.gitignore

@@ -6,3 +6,4 @@ test/resources/auth.js
 test/integration/
 test/resources/tts-output.ogg
 .idea
+doc/

.npmignore

@@ -12,3 +12,5 @@ examples
 LICENSE
 CONTRIBUTING.md
 RELEASE.md
+jsdoc/
+doc/

.travis.yml

@@ -6,7 +6,14 @@ node_js:
 - stable
 script:
 - npm test
+- npm run doc
 after_success:
 - npm run coveralls
+- jsdoc/publish.sh
 before_install:
-- '[ "${TRAVIS_PULL_REQUEST}" = "false" ] && openssl aes-256-cbc -K $encrypted_cb4d3d070e32_key -iv $encrypted_cb4d3d070e32_iv -in auth.js.enc -out test/resources/auth.js -d || true'
+- '[ "${TRAVIS_PULL_REQUEST}" = "false" ] && openssl aes-256-cbc -K $encrypted_cb4d3d070e32_key
+  -iv $encrypted_cb4d3d070e32_iv -in auth.js.enc -out test/resources/auth.js -d ||
+  true'
+env:
+  global:
+    secure: I50FnfubwiZlol5Qs9tXPVACGbs+SG2dJLjpbzeio0Hl666d/hDuvf7IFwqqaRjQkmK2TdIjaGLMOgHxh/GGAoYf7LfZqjDID/tAhgoFOYiZwiPj66Z82F9P9cega2nkNW+125NzPuU3rhSCByG8+K/PMH/5JxPwPMoAYNLQjWc=

CONTRIBUTING.md

@@ -16,7 +16,7 @@ or [Stack Overflow](http://stackoverflow.com/questions/ask?tags=ibm-watson).
   ```
 * commits should start with the service name and end with the issue #  
   ```
-  [DC] Add conversion to html #13
+  [concept-insights] Added functionality to list the graphs #135
   ``` 
 
 # Issues

jsdoc/config.json

@@ -0,0 +1,12 @@
+{
+  "source": {
+    "include": [ "lib/", "services/" ]
+  },
+  "opts": {
+    "package": "package.json",
+    "readme": "README.md",
+    "recurse": true,
+    "template": "jsdoc/template",
+    "destination": "./doc/"
+  }
+}

jsdoc/publish.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+# based on http://benlimmer.com/2013/12/26/automatically-publish-javadoc-to-gh-pages-with-travis-ci/
+# todo: add    && [ "$TRAVIS_TAG" != "" ] after confirming it works otherwise
+
+if [ "$TRAVIS_REPO_SLUG" == "watson-developer-cloud/node-sdk" ] && [ "$TRAVIS_PULL_REQUEST" == "false" ] && [ "$TRAVIS_BRANCH" == "master" ] && [ "$TRAVIS_TAG" ]; then
+
+  echo "Publishing JSDoc..."
+
+  git config --global user.email "[email protected]"
+  git config --global user.name "travis-ci"
+  git clone --quiet --branch=gh-pages https://${GH_TOKEN}@github.com/watson-developer-cloud/node-sdk gh-pages > /dev/null
+
+  pushd gh-pages
+    cp -Rf ../doc/watson-developer-cloud/* ./
+    git add -f .
+    git commit -m "JSDdoc for $TRAVIS_TAG"
+    git push -fq origin gh-pages > /dev/null
+  popd
+
+  echo -e "Published JSDoc for $TRAVIS_TAG to gh-pages.\n"
+
+else
+
+  echo -e "Not publishing docs for tag $TRAVIS_TAG on branch $TRAVIS_BRANCH of repo $TRAVIS_REPO_SLUG"
+
+fi

jsdoc/template/README.md

@@ -0,0 +1,12 @@
+The default template for JSDoc 3 uses: [the Taffy Database library](http://taffydb.com/) and the [Underscore Template library](http://documentcloud.github.com/underscore/#template).
+
+
+## Generating Typeface Fonts
+
+The default template uses the [OpenSans](https://www.google.com/fonts/specimen/Open+Sans) typeface. The font files can be regenerated as follows:
+
+1. Open the [OpenSans page at Font Squirrel](<http://www.fontsquirrel.com/fonts/open-sans>).
+2. Click on the 'Webfont Kit' tab.
+3. Either leave the subset drop-down as 'Western Latin (Default)', or, if we decide we need more glyphs, than change it to 'No Subsetting'.
+4. Click the 'DOWNLOAD @FONT-FACE KIT' button.
+5. For each typeface variant we plan to use, copy the 'eot', 'svg' and 'woff' files into the 'templates/default/static/fonts' directory.