Skip to content

Commit 1d48b48

Browse files
docs: switch to docgen style typedoc configuration
1 parent 4ff9c51 commit 1d48b48

File tree

6 files changed

+274
-204
lines changed

6 files changed

+274
-204
lines changed

docgen.json

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{
2+
"publishDir": "_ng2_docs",
3+
"navigation": {
4+
"": ["UIRouter"],
5+
"Services": ["StateService", "StateRegistry", "TransitionService", "UrlService", "UrlConfig", "UrlRules"],
6+
"Components": ["UIView", "UISref", "UISrefActive"],
7+
"Other": ["Transition", "Trace"]
8+
},
9+
"include": [
10+
{
11+
"pkg": "@uirouter/core",
12+
"repo": "https://github.com/ui-router/core",
13+
"branch": "master"
14+
},
15+
{
16+
"pkg": "@uirouter/rx",
17+
"repo": "https://github.com/ui-router/rx"
18+
}
19+
],
20+
"tsconfig": {
21+
"compilerOptions": {
22+
"baseUrl": "./src",
23+
"paths": {
24+
"@uirouter/core": ["@uirouter/core/src"],
25+
"@uirouter/core/lib/globals": ["@uirouter/core/src/globals"],
26+
"@uirouter/rx": ["@uirouter/rx/src"]
27+
}
28+
}
29+
}
30+
}

package.json

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,26 +57,28 @@
5757
"@types/jest": "^25.1.4",
5858
"@types/jquery": "^3.3.33",
5959
"@uirouter/core": "^6.0.1",
60-
"@uirouter/publish-scripts": "^2.3.48",
60+
"@uirouter/publish-scripts": "^2.4.2",
6161
"@uirouter/rx": "^0.6.0",
6262
"husky": "^4.2.3",
6363
"jest": "^25.1.0",
6464
"jest-preset-angular": "^8.1.2",
6565
"ng-packagr": "=5.5.1",
6666
"prettier": "^2.0.5",
6767
"pretty-quick": "^2.0.1",
68-
"rollup": "^2.0.6",
68+
"rollup": "1.32.1",
6969
"rollup-plugin-commonjs": "^10.0.0",
7070
"rollup-plugin-node-resolve": "^5.0.2",
7171
"rollup-plugin-sourcemaps": "^0.5.0",
7272
"rollup-plugin-uglify": "^6.0.4",
7373
"rxjs": "^6.5.4",
7474
"rxjs-compat": "^6.5.4",
7575
"ts-loader": "^6.2.1",
76-
"tslib": "^1.9.3",
76+
"tslib": "1.13.0",
7777
"tslint": "^6.1.0",
78-
"typescript": "~3.5.3",
79-
"zone.js": "~0.10.2"
78+
"typedoc": "~0.17.7",
79+
"typedoc-plugin-ui-router": "^3.0.1",
80+
"typescript": "3.5.3",
81+
"zone.js": "0.9.1"
8082
},
8183
"ngPackage": {
8284
"lib": {

tsconfig.json

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"moduleResolution": "node",
66
"module": "es6",
77
"target": "es5",
8-
"lib": [ "es6", "dom" ],
8+
"lib": ["es6", "dom"],
99
"allowSyntheticDefaultImports": true,
1010
"skipLibCheck": true,
1111
"rootDir": "src",
@@ -19,7 +19,5 @@
1919
"skipTemplateCodegen": true,
2020
"strictMetadataEmit": true
2121
},
22-
"files": [
23-
"src/index.ts"
24-
]
22+
"files": ["src/index.ts"]
2523
}

tsconfig.typedoc.json

Lines changed: 0 additions & 33 deletions
This file was deleted.

typedoc.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"name": "@uirouter/angular",
3+
"readme": "README.md",
4+
"out": "_doc",
5+
"stripInternal": true,
6+
"excludeNotExported": true,
7+
"excludePrivate": true
8+
}

0 commit comments

Comments
 (0)