Updated jsdoc config and theme to one that's a lot more readable than…

… the default.
fooplugins · Sep 16, 2016 · 38fb9cb · 38fb9cb
1 parent e6a85cc
commit 38fb9cb
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 23 deletions.
diff --git a/GruntFile.js b/GruntFile.js
@@ -294,9 +294,15 @@ module.exports = function (grunt) {
 		},
 		jsdoc: {
 			dist: {
+				src: [
+					'./src/js/**/*.js',
+					'README.md'
+				],
+				jsdoc: './node_modules/.bin/jsdoc',
 				options: {
 					destination: 'docs/jsdocs',
-					configure: 'jsdoc.json'
+					configure: 'jsdoc.json',
+					template: './node_modules/jsdoc-oblivion/template'
 				}
 			}
 		}

diff --git a/jsdoc.json b/jsdoc.json
@@ -3,20 +3,23 @@
     "allowUnknownTags": true
   },
   "source": {
-    "include": ["./src/js","README.md"],
     "includePattern": ".+\\.js(doc)?$",
-    "excludePattern": "docs|lib"
+    "excludePattern": "(^|\\/|\\\\)_"
   },
+  "plugins": [],
   "templates": {
-    "applicationName": "FooTable V3",
-    "default":{
-      "outputSourceFiles": false
-    },
     "cleverLinks": false,
-    "monospaceLinks": true
-  },
-  "opts": {
-    "recurse": true,
-    "private": true
+    "monospaceLinks": false,
+    "default": {
+      "outputSourceFiles": true
+    },
+    "systemName"      : "FooTable V3",
+    "footer"          : "",
+    "copyright"       : "Copyright © 2016",
+    "navType"         : "vertical",
+    "theme"           : "oblivion",
+    "linenums"        : true,
+    "collapseSymbols" : false,
+    "inverseNav"      : true
   }
 }
diff --git a/package.json b/package.json
@@ -24,22 +24,24 @@
     "type": "git",
     "url": "https://github.com/fooplugins/footable.git"
   },
-  "devDependencies": {
-    "grunt": "^0.4.1",
-    "grunt-contrib-clean": "^0.4.1",
-    "grunt-contrib-compress": "^0.13.0",
-    "grunt-contrib-concat": "^0.3.0",
-    "grunt-contrib-copy": "^0.8.2",
-    "grunt-contrib-cssmin": "^0.14.0",
-    "grunt-contrib-uglify": "^0.11.0",
-    "grunt-jsdoc": "^1.1.0"
-  },
   "scripts": {
     "test": "grunt test"
   },
   "keywords": [
     "jquery",
     "table",
     "responsive"
-  ]
+  ],
+  "dependencies": {
+    "grunt": "^0.4.1",
+    "grunt-contrib-clean": "^0.4.1",
+    "grunt-contrib-compress": "^0.13.0",
+    "grunt-contrib-concat": "^0.3.0",
+    "grunt-contrib-copy": "^0.8.2",
+    "grunt-contrib-cssmin": "^0.14.0",
+    "grunt-contrib-uglify": "^0.11.0",
+    "jsdoc": "^3.4.1",
+    "grunt-jsdoc": "^1.1.0",
+    "jsdoc-oblivion": "0.0.4"
+  }
 }