API docs using yuidocsjs

readium · Feb 2, 2016 · e4103c2 · e4103c2
1 parent e916f22
commit e4103c2
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+api-docs
 build-output
 dist
 .idea
@@ -14,4 +15,4 @@ http.log
 http_ebooks.log
 http_app.log
 http_app-ebooks.log
-.vscode
+.vscode
diff --git a/package.json b/package.json
@@ -84,7 +84,8 @@
     "prepare": "npm run prepare:submodule && npm run prepare:local",
     "prepare:local": "npm outdated && npm install && npm update && node readium-js/readium-shared-js/readium-cfi-js/readium-build-tools/gitHubForksUpdater.js",
     "prepare:submodule": "cd readium-js && npm run prepare && cd .. && ls",
-    "clean": "node --version && npm --version && node ./readium-js/readium-shared-js/readium-cfi-js/node_modules/rimraf/bin.js build-output && node ./readium-js/readium-shared-js/readium-cfi-js/node_modules/rimraf/bin.js dist",
+    "clean": "node --version && npm --version && node ./readium-js/readium-shared-js/readium-cfi-js/node_modules/rimraf/bin.js build-output && node ./readium-js/readium-shared-js/readium-cfi-js/node_modules/rimraf/bin.js api-docs/* && node ./readium-js/readium-shared-js/readium-cfi-js/node_modules/rimraf/bin.js dist",
+    "apidocs": "node ./readium-js/readium-shared-js/readium-cfi-js/node_modules/yuidocjs/lib/cli.js -N -C -c yuidocs.json",
     "prebuild": "npm run clean",
     "build": "npm run build:scripts",
     "lint": "node ./readium-js/readium-shared-js/readium-cfi-js/readium-build-tools/jshint_glob.js js/**.js",

diff --git a/package/package_scripts_build.cson b/package/package_scripts_build.cson
@@ -13,10 +13,19 @@
         npm run rimraf
             build-output
         &&
+        npm run rimraf
+            api-docs/*
+        &&
         npm run rimraf
             dist
     '
 
+#=====================
+    apidocs: '
+
+        npm run yuidocjs
+    '
+
 #=====================
     'prebuild': '
 

diff --git a/readium-js b/readium-js
diff --git a/yuidocs.json b/yuidocs.json
@@ -0,0 +1,16 @@
+{
+  "COMMAND LINE": "node node_modules/yuidocjs/lib/cli.js -N -C -c yuidocs.json",
+  "name": "readium-js-viewer",
+  "description": "Readium - viewer (reader+library) written in Javascript+HTML+CSS etc.",
+  "version": "0.0.0",
+  "url": "https://github.com/readium/readium-js-viewer",
+  "logo": "http://readium.org/sites/readium.org/files/header-logo.png",
+  "options": {
+    "linkNatives": "true",
+    "exclude": "readium-js,epub_content,package,src,lib,node_modules,api-docs,dev,tests,gen,build-output,dist,build-config",
+    "paths": [
+      "src"
+    ],
+    "outdir": "./api-docs"
+  }
+}
+2 −0		.gitignore
+8 −0		package.cson
+2 −1		package.json
+1 −1		readium-shared-js
+16 −0		yuidocs.json