apidoc implementation

GladysAssistant · Oct 27, 2016 · beb9e3c · beb9e3c
1 parent 55eb1fa
commit beb9e3c
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -40,6 +40,7 @@
 ################################################
 
 #config/googleapi.js
+apidoc
 
 
 

diff --git a/apidoc.json b/apidoc.json
@@ -0,0 +1,6 @@
+{
+  "name": "gladys",
+  "version": "0.1.0",
+  "description": "Gladys REST API documentation",
+  "title": "Gladys REST API documentation"
+}
diff --git a/package.json b/package.json
@@ -54,6 +54,7 @@
     "suncalc": "^1.7.0"
   },
   "devDependencies": {
+    "grunt-apidoc": "^0.11.0",
     "grunt-contrib-csslint": "^1.0.0",
     "grunt-mocha-istanbul": "^5.0.1",
     "istanbul": "^0.4.2",

diff --git a/tasks/config/apidoc.js b/tasks/config/apidoc.js
@@ -0,0 +1,14 @@
+/**
+ * Generate documentation
+ */
+module.exports = function(grunt) {
+
+	grunt.config.set('apidoc', {
+		myapp: {
+            src: "api/",
+            dest: "apidoc/"
+        }
+	});
+
+	grunt.loadNpmTasks('grunt-apidoc');
+};
diff --git a/tasks/register/generateDoc.js b/tasks/register/generateDoc.js
@@ -0,0 +1,3 @@
+module.exports = function (grunt) {
+	grunt.registerTask('generate-doc', ['apidoc']);
+};