Merge pull request #66 from lgeiger/docs

Publish docs to github pages

Author: rgbkrk

.gitignore

@@ -13,6 +13,7 @@ npm-debug.log
 gyp-mac-tool
 out/
 zmq
+docs
 
 npm-debug.log
 prebuilds

.travis.yml

@@ -20,7 +20,8 @@ env:
     - NODE_VERSION="6" ELECTRON="1.1.3"
     - NODE_VERSION="6" ELECTRON="1.4.3" REBUILD="true"
   global:
-    secure: AMY9chDNyNawxPhxAksCREhbQoOmphQKo2hDuYIPXBCUNF6Zik969QlB07TVjo+Bo0KVEbG4ANTdI0FkFIhg4MuJIWUkW30ZDyCSovUx8zyWB/7IN23A4Cx4p4ZnKjezTHUQpZ9InRIZzy9kOR+215IIBP6GfxbUY89eDA6ARElcv1rwDjZqSnLAxfie6v80vIbhWxNK4kQjiEyIez5eWBjRg4//dmb63TvJjc78GFTaqmh6lRIApAyA0uKka14XR/PJw5IpDR+0Q2omHl4t4zbu9MdVNYMSD+c6iNxOq3fqZJwnyJ1ELErbtR8oeKgZX1SOew5QTCUZWQsa+ySYTCzUnhWjhCgN6W0ciVtT2PslS/ZcvnrGGIxJAOmTZwINw8sAp8yYdY9QCJOGdB5ah2oUBLGKElcFGqSblohXUEM1tXeRchmpXiiAxnPNtxc6lkZzz6NxDl2OFXSmjMS4Cr8cA//Bn6gM04xRJyETy86/8KDoL+ENc7gkeiuYUOFqkAn5X8PrqPdsPmF7yA61IF1ru/OgtiuCh+eqnzZKBPImJo2KfUIqVuRi/6eUaDfWLT7d/J84Vbe3p2nPxoFd2pSw60f/lIkzFSRZx3vBjQiW2MVUN7ZTdawMOzE4TpIV7rDOkKe7qJJobquJEjd2X9Z+8JiTYXK2pPN2GceiqAM=
+    - GH_REF: github.com/nteract/zmq-prebuilt.git
+    - secure: AMY9chDNyNawxPhxAksCREhbQoOmphQKo2hDuYIPXBCUNF6Zik969QlB07TVjo+Bo0KVEbG4ANTdI0FkFIhg4MuJIWUkW30ZDyCSovUx8zyWB/7IN23A4Cx4p4ZnKjezTHUQpZ9InRIZzy9kOR+215IIBP6GfxbUY89eDA6ARElcv1rwDjZqSnLAxfie6v80vIbhWxNK4kQjiEyIez5eWBjRg4//dmb63TvJjc78GFTaqmh6lRIApAyA0uKka14XR/PJw5IpDR+0Q2omHl4t4zbu9MdVNYMSD+c6iNxOq3fqZJwnyJ1ELErbtR8oeKgZX1SOew5QTCUZWQsa+ySYTCzUnhWjhCgN6W0ciVtT2PslS/ZcvnrGGIxJAOmTZwINw8sAp8yYdY9QCJOGdB5ah2oUBLGKElcFGqSblohXUEM1tXeRchmpXiiAxnPNtxc6lkZzz6NxDl2OFXSmjMS4Cr8cA//Bn6gM04xRJyETy86/8KDoL+ENc7gkeiuYUOFqkAn5X8PrqPdsPmF7yA61IF1ru/OgtiuCh+eqnzZKBPImJo2KfUIqVuRi/6eUaDfWLT7d/J84Vbe3p2nPxoFd2pSw60f/lIkzFSRZx3vBjQiW2MVUN7ZTdawMOzE4TpIV7rDOkKe7qJJobquJEjd2X9Z+8JiTYXK2pPN2GceiqAM=
 
 before_install:
   - export DISPLAY=':99.0'
@@ -43,7 +44,9 @@ deploy:
   provider: script
   skip_cleanup: true
   # Linking to prebuild directly since it doesn't work inside a npm script.
-  script: node_modules/prebuild/bin.js --all -u $GH_TOKEN
+  script:
+    - node_modules/prebuild/bin.js --all -u $GH_TOKEN
+    - bash ./travis_publish_docs.sh
   on:
     condition: "$DEPLOY = true"
     tags: true

build_libzmq.sh

@@ -17,7 +17,7 @@ export CFLAGS=-fPIC
 export CXXFLAGS=-fPIC
 export PKG_CONFIG_PATH=$ZMQ_PREFIX/lib/pkgconfig
 
-test -f zeromq-$ZMQ.tar.gz || ZMQ=$ZMQ ZMQ_REPO=$ZMQ_REPO node ../download-zmq.js 2>&1 > ../zmq-build.log
+test -f zeromq-$ZMQ.tar.gz || ZMQ=$ZMQ ZMQ_REPO=$ZMQ_REPO node ../scripts/download-zmq.js 2>&1 > ../zmq-build.log
 test -d $ZMQ_SRC_DIR || tar xzf zeromq-$ZMQ.tar.gz
 cd $ZMQ_SRC_DIR
 

package.json

@@ -15,6 +15,7 @@
   },
   "devDependencies": {
     "electron-mocha": "^3.1.1",
+    "jsdoc": "^3.4.2",
     "mocha": "^3.1.0",
     "semver": "^5.3.0",
     "should": "^11.1.0"
@@ -24,6 +25,7 @@
   },
   "scripts": {
     "install": "prebuild --install",
+    "build:docs": "jsdoc -R README.md -d docs lib/*.js",
     "test": "mocha --expose-gc --slow 300 --timeout 4000",
     "test:electron": "electron-mocha --slow 300 --timeout 4000"
   },

download-zmq.js scripts/download-zmq.jsdownload-zmq.js renamed to scripts/download-zmq.js

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+npm run build:docs
+
+( cd docs
+git init
+git config user.email "travis@travis-ci.com"
+git config user.name "Travis Bot"
+
+git add .
+git commit -m "Publish docs from $TRAVIS_BUILD_NUMBER"
+git push --force --quiet "https://${GH_TOKEN}@${GH_REF}" master:gh-pages > /dev/null 2>&1
+echo "Documentation has been published!"
+)