Skip to content

Commit

Permalink
remove docs script in each package as we now have the root documentat…
Browse files Browse the repository at this point in the history
…ion that is generating the typedoc for the whole modules

Change-Id: I0c47554e1a99e22c7b519c94afa7cfd9be1622a4
Signed-off-by: Florent Benoit <[email protected]>
  • Loading branch information
benoitf committed Apr 3, 2019
1 parent 0dab9af commit 23fd73a
Show file tree
Hide file tree
Showing 55 changed files with 204 additions and 158 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ jobs:
before_deploy:
- printf "//registry.npmjs.org/:_authToken=${NPM_AUTH_TOKEN}\n" >> ~/.npmrc
- yarn
- yarn run docs-modules
- yarn run docs
deploy:
- provider: script
script: yarn run publish:next
Expand Down
7 changes: 2 additions & 5 deletions configs/typedoc-tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
// This file could be removed when
// https://github.com/TypeStrong/typedoc/issues/844
// will be integrated in a new typedocs release (should be 0.14.0)
{
"extends": "./base.tsconfig",
"extends": "../tsconfig",
"compilerOptions": {
"declarationMap": false
"skipLibCheck": true
}
}
16 changes: 13 additions & 3 deletions configs/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
{
"ignoreCompilerErrors": true,
"mode": "file",
"out": "docs/api",
"mode": "modules",
"out": "gh-pages/docs/next",
"excludeExternals": true,
"includeDeclarations": true
"includeDeclarations": true,
"readme": "README.md",
"module": "commonjs",
"target": "es6",
"hideGenerator": true,
"external-modulemap": ".*\/packages\/([\\w\\-_]+)\/",
"name": "Theia TypeDoc",
"exclude": [
"**/+(dev-packages|examples|typings)/**/*.ts",
"**/*spec.ts"
]
}
3 changes: 1 addition & 2 deletions dev-packages/application-manager/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"dependencies": {
"@theia/application-package": "^0.5.0",
Expand Down
3 changes: 1 addition & 2 deletions dev-packages/application-package/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"dependencies": {
"@types/fs-extra": "^4.0.2",
Expand Down
3 changes: 1 addition & 2 deletions dev-packages/cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,7 @@
"clean": "rimraf lib",
"build": "tsc -p compile.tsconfig.json",
"watch": "yarn build -w",
"test": "echo 'skip'",
"docs": "echo 'skip'"
"test": "echo 'skip'"
},
"dependencies": {
"@theia/application-manager": "^0.5.0"
Expand Down
5 changes: 1 addition & 4 deletions dev-packages/ext-scripts/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,12 @@
"build": "echo 'skip'",
"watch": "echo 'skip'",
"test": "echo 'skip'",
"docs": "echo 'skip'",
"ext:clean": "theiaext compile:clean && theiaext docs:clean && theiaext test:clean",
"ext:clean": "theiaext compile:clean && theiaext test:clean",
"ext:build": "concurrently -n compile,lint -c blue,green \"theiaext compile\" \"theiaext lint\"",
"ext:compile": "tsc -p compile.tsconfig.json",
"ext:compile:clean": "rimraf lib",
"ext:lint": "tslint -c ../../configs/build.tslint.json --project compile.tsconfig.json",
"ext:watch": "tsc -w -p compile.tsconfig.json",
"ext:docs": "typedoc --tsconfig ../../configs/typedoc-tsconfig.json --options ../../configs/typedoc.json src",
"ext:docs:clean": "rimraf docs/api",
"ext:test": "nyc mocha --opts ../../configs/mocha.opts \"./lib/**/*.*spec.js\"",
"ext:test:watch": "mocha -w --opts ../../configs/mocha.opts \"./lib/**/*.*spec.js\"",
"ext:test:clean": "rimraf .nyc_output && rimraf coverage"
Expand Down
5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"temp": "^0.8.3",
"tslint": "^5.12.0",
"tslint-language-service": "^0.9.9",
"typedoc": "^0.13.0",
"typedoc": "^0.15.0-0",
"typedoc-plugin-external-module-map": "^1.0.0",
"typescript": "^3.1.3",
"uuid": "^3.1.0",
Expand All @@ -50,8 +50,7 @@
"prepare:hoisting": "theia check:hoisted -s",
"build": "run build",
"build:clean": "run prepare",
"docs": "run docs \"@theia/!(example-)*\"",
"docs-modules": "rimraf gh-pages/docs/next && typedoc --readme README.MD --name 'Theia TypeDoc' --exclude '**/+(dev-packages|examples|typings)/**/*.ts' --options configs/typedoc.json --module commonjs --target es6 --hideGenerator --mode modules --external-modulemap '.*\/packages\/([\\w\\-_]+)\/' --out gh-pages/docs/next",
"docs": "rimraf gh-pages/docs/next && typedoc --tsconfig configs/typedoc-tsconfig.json --options configs/typedoc.json",
"test": "yarn test:theia && yarn test:electron && yarn test:browser",
"test:theia": "run test \"@theia/!(example-)*\" --stream --concurrency=1",
"test:browser": "yarn rebuild:browser && run test \"@theia/example-browser\"",
Expand Down
3 changes: 1 addition & 2 deletions packages/bunyan/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/callhierarchy/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/console/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/cpp/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/debug-nodejs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/debug/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/editor-preview/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/editor/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/editorconfig/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/extension-manager/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/file-search/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/filesystem/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,7 @@
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"test:watch": "theiaext test:watch",
"docs": "theiaext docs"
"test:watch": "theiaext test:watch"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/getting-started/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"test:watch": "theiaext test:watch",
"docs": "theiaext docs"
"test:watch": "theiaext test:watch"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/git/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,7 @@
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"test:watch": "theiaext test:watch",
"docs": "theiaext docs"
"test:watch": "theiaext test:watch"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0",
Expand Down
3 changes: 1 addition & 2 deletions packages/java-debug/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
1 change: 0 additions & 1 deletion packages/java/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs",
"dev-server": "node ./scripts/get-dev-server.js"
},
"publishConfig": {
Expand Down
3 changes: 1 addition & 2 deletions packages/json/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"publishConfig": {
"access": "public"
Expand Down
3 changes: 1 addition & 2 deletions packages/keymaps/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"nyc": {
"extends": "../../configs/nyc.json"
Expand Down
3 changes: 1 addition & 2 deletions packages/languages/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/markers/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/merge-conflicts/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/messages/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/metrics/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/mini-browser/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/monaco/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/navigator/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/outline-view/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
3 changes: 1 addition & 2 deletions packages/output/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,7 @@
"clean": "theiaext clean",
"build": "theiaext build",
"watch": "theiaext watch",
"test": "theiaext test",
"docs": "theiaext docs"
"test": "theiaext test"
},
"devDependencies": {
"@theia/ext-scripts": "^0.5.0"
Expand Down
Loading

0 comments on commit 23fd73a

Please sign in to comment.