From 8f1762a4207a8ae857bed58a6015afe882953193 Mon Sep 17 00:00:00 2001 From: Prateek Saxena Date: Fri, 11 Mar 2016 16:05:48 +0530 Subject: [PATCH] docs: Use the standard way of generating documentation * Move the files from the docs directory * Remove the generate script * Add npm task Change-Id: I2b404e132aab0be563c7abb9145ab607242c94cd --- .gitignore | 2 +- docs/generate | 4 ---- docs/categories.json => jsduck.categories.json | 0 docs/external.js => jsduck.external.js | 0 jsduck.json | 4 ++-- package.json | 3 ++- 6 files changed, 5 insertions(+), 8 deletions(-) delete mode 100755 docs/generate rename docs/categories.json => jsduck.categories.json (100%) rename docs/external.js => jsduck.external.js (100%) diff --git a/.gitignore b/.gitignore index dcd7e218f..c40aa38d0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ -docs/js/ +docs/ node_modules/ diff --git a/docs/generate b/docs/generate deleted file mode 100755 index 6b7c77b6c..000000000 --- a/docs/generate +++ /dev/null @@ -1,4 +0,0 @@ -#!/usr/bin/env bash -set -e -cd $(dirname $0)/.. -jsduck diff --git a/docs/categories.json b/jsduck.categories.json similarity index 100% rename from docs/categories.json rename to jsduck.categories.json diff --git a/docs/external.js b/jsduck.external.js similarity index 100% rename from docs/external.js rename to jsduck.external.js diff --git a/jsduck.json b/jsduck.json index 29a395dbc..a9be81f98 100644 --- a/jsduck.json +++ b/jsduck.json @@ -1,12 +1,12 @@ { "--title": "MultimediaViewer - Documentation", - "--categories": "docs/categories.json", + "--categories": "jsduck.categories.json", "--builtin-classes": true, "--processes": "0", "--warnings-exit-nonzero": true, "--output": "docs", "--": [ - "docs/external.js", + "jsduck.external.js", "resources/mmv" ] } diff --git a/package.json b/package.json index 72eb4aa7f..c78fc192a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,8 @@ { "private": true, "scripts": { - "test": "grunt test" + "test": "grunt test", + "doc": "jsduck" }, "devDependencies": { "grunt": "0.4.5",