Browse Source

Reinstate the docs build

Steven Silvester 9 years ago
parent
commit
c0f594ec2f
4 changed files with 5 additions and 14 deletions
  1. 2 0
      README.md
  2. 2 2
      package.json
  3. 0 11
      scripts/tdoptions.json
  4. 1 1
      scripts/travis_script.sh

+ 2 - 0
README.md

@@ -4,6 +4,8 @@ Jupyter JS Plugins
 Plugins for JupyterLab.  The default set of [phosphide](https://github.com/phosphorjs/phosphide) 
 plugins used to create [JupyterLab](https://github.com/jupyter/notebook/tree/master/notebook/lab).
 
+[API Docs](http://jupyter.github.io/jupyter-js-plugins/)
+
 ![JupyterLab Demo](jupyter-plugins-demo.gif)
 
 

+ 2 - 2
package.json

@@ -42,7 +42,7 @@
     "mocha": "^2.3.4",
     "rimraf": "^2.5.0",
     "style-loader": "^0.13.0",
-    "typedoc": "^0.3.12",
+    "typedoc": "https://github.com/SierraSoftworks/typedoc.git#cb5aea2b218b4f773451e2818a48629ee9c5066e",
     "typescript": "^1.8.0",
     "url-loader": "^0.5.7",
     "watch": "^0.17.1",
@@ -55,7 +55,7 @@
     "build:src": "tsc --project src && node scripts/copycss.js",
     "build:test": "tsc --project test/src && webpack --config test/webpack.conf.js",
     "build": "npm run build:src && npm run build:test",
-    "docs": "typedoc --options scripts/tdoptions.json",
+    "docs": "typedoc --mode file --module commonjs --excludeNotExported --target es5 --moduleResolution node --out docs/ src",
     "postinstall": "npm dedupe",
     "prepublish": "npm run build",
     "test:chrome": "karma start --browsers=Chrome test/karma.conf.js",

+ 0 - 11
scripts/tdoptions.json

@@ -1,11 +0,0 @@
-{
-  "module": "commonjs",
-  "target": "ES5",
-  "excludeNotExported": true,
-  "experimentalDecorators": true,
-  "mode": "file",
-  "out": "docs",
-  "src": [
-    "src"
-  ]
-}

+ 1 - 1
scripts/travis_script.sh

@@ -9,4 +9,4 @@ npm test
 npm run test:coverage
 export PATH="$HOME/miniconda/bin:$PATH"
 npm run build:example
-#npm run docs
+npm run docs