Merge pull request #286 from Turbo87/docs

Add `documentation` dev dependency

.gitignore

@@ -2,6 +2,7 @@
 
 # compiled output
 /dist
+/docs
 /tmp
 
 # dependencies

.npmignore

@@ -1,5 +1,6 @@
 # compiled output
 /dist
+/docs
 /tmp
 
 # dependencies

.travis.yml

@@ -58,6 +58,16 @@ jobs:
         on:
           tags: true
           repo: emberjs/ember-test-helpers
+    - if: tag IS present
+      script: yarn documentation
+      deploy:
+        provider: pages
+        skip_cleanup: true
+        local_dir: docs
+        github_token: $GITHUB_TOKEN # Set in travis-ci.org dashboard
+        on:
+          tags: true
+          repo: emberjs/ember-test-helpers
 
 before_install:
   - curl -o- -L https://yarnpkg.com/install.sh | bash

documentation.yml

@@ -0,0 +1,50 @@
+toc:
+  - name: DOM Interaction Helpers
+
+  - click
+  - tap
+  - focus
+  - blur
+  - triggerEvent
+  - triggerKeyEvent
+  - fillIn
+
+  - name: Routing Helpers
+
+  - visit
+  - currentRouteName
+  - currentURL
+
+  - name: Rendering Helpers
+
+  - render
+  - clearRender
+
+  - name: Wait Helpers
+
+  - waitFor
+  - waitUntil
+  - settled
+  - isSettled
+  - getSettledState
+
+  - name: Pause Helpers
+
+  - pauseTest
+  - resumeTest
+
+  - name: Test Framework APIs
+
+  - setResolver
+  - getResolver
+  - setupContext
+  - getContext
+  - setContext
+  - unsetContext
+  - teardownContext
+  - setupRenderingContext
+  - teardownRenderingContext
+  - setApplication
+  - setupApplicationContext
+  - teardownApplicationContext
+  - validateErrorHandler

package.json

@@ -25,6 +25,7 @@
   "scripts": {
     "build": "ember build",
     "changelog": "lerna-changelog",
+    "docs": "documentation build --document-exported \"addon-test-support/@ember/test-helpers/index.js\" --config documentation.yml -f html -o docs",
     "lint": "eslint *.js addon addon-test-support app config lib node-tests server tests test-support",
     "start": "ember server",
     "test": "ember test",
@@ -36,6 +37,7 @@
     "ember-cli-htmlbars-inline-precompile": "^1.0.0"
   },
   "devDependencies": {
+    "documentation": "^5.3.5",
     "ember-cli": "^2.17.1",
     "ember-cli-dependency-checker": "^2.0.0",
     "ember-cli-eslint": "^4.2.1",