Features/17

.gitignore

@@ -1,9 +1,7 @@
-### IntelliJ ###
+### Node.js ###
+node_modules/
 
-*.iml
-.idea
-
-### ANSIBLE ###
+### Ansible ###
 *.retry
 .galaxy_install_info
 */roles
@@ -16,3 +14,4 @@
 
 ### Build ###
 deps
+build

.travis.yml

@@ -12,7 +12,7 @@ install:
 - pip install molecule==1.25.0
 - pip install docker
 script:
-- travis_wait 30 molecule test --driver docker
+- travis_wait 60 molecule test --driver docker
 deploy:
   provider: npm
   email: [email protected]

CHANGELOG.md

@@ -5,7 +5,8 @@ This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a ch
 ## [Unreleased](https://github.com/idealista/yatm/tree/develop)
 
 ### Added
-- - [#14](https://github.com/idealista/yatm/issues/14) *Adding support to Debian Jessie* @dortega
+- [#14](https://github.com/idealista/yatm/issues/14) *Adding support to Debian Jessie* @dortega
+- [#17](https://github.com/idealista/yatm/issues/17) *Adding static documentation pages generated with JSDoc* @dortega
 
 ### Fixed
 - [#15](https://github.com/idealista/yatm/issues/15) *Using exiv2-role v1.0.1 because source package download is not working anymore* @dortega

Gruntfile.js

@@ -1,5 +1,4 @@
 module.exports = function(grunt) {
-    // project configuration
     grunt.initConfig({
         pkg : grunt.file.readJSON('package.json'),
         jshint : {
@@ -19,14 +18,25 @@ module.exports = function(grunt) {
                     }
                 }
             }
+        },
+        jsdoc : {
+            dist : {
+              src: ['*.js', 'README.md'],
+              options: {
+                  destination : 'docs',
+                  template : "node_modules/ink-docstrap/template",
+                  configure : "jsdoc.conf.json"
+              }
+            }
         }
     });
 
     grunt.loadNpmTasks('grunt-contrib-jshint');
     grunt.loadNpmTasks('grunt-contrib-nodeunit');
+    grunt.loadNpmTasks("grunt-jsdoc");
 
     // default task(s)
-    grunt.registerTask('default', ['jshint', 'nodeunit:local']);
+    grunt.registerTask('default', ['jshint', 'nodeunit:local', 'jsdoc']);
 
     // tasks for continuous integration (jenkins)
     grunt.registerTask('jenkins', ['jshint', 'nodeunit:ci']);

README.md

@@ -111,10 +111,11 @@ $ molecule test
 
 ![Node.js](https://img.shields.io/badge/Node.js-8.9.1-green.svg)
 
-![Ansible](https://img.shields.io/badge/ansible-2.3.1.0-green.svg)
+![Grunt](https://img.shields.io/badge/Grunt-1.0.2-green.svg)
 
-![Molecule](https://img.shields.io/badge/molecule-1.25.0-green.svg)
+![Ansible](https://img.shields.io/badge/Ansible-2.3.1.0-green.svg)
 
+![Molecule](https://img.shields.io/badge/Molecule-1.25.0-green.svg)
 
 ## Versioning
 

buildlib/group_vars/yatm/main.yml

@@ -9,6 +9,7 @@ yatm_build_files:
     - .jshintignore
     - .jshintrc
     - .npmignore
+    - jsdoc.conf.json
     - binding.gyp
     - Gruntfile.js
     - index.js