Skip to content

Commit eea7de7

Browse files
docs: upgrade to publish-scripts 2.5.2 with docker based docgen
1 parent db4e63f commit eea7de7

File tree

5 files changed

+275
-314
lines changed

5 files changed

+275
-314
lines changed

package.json

+36-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@
8484
"@types/angular-animate": "^1.5.10",
8585
"@types/angular-mocks": "^1.7.0",
8686
"@types/jest": "^25.2.3",
87-
"@uirouter/publish-scripts": "2.3.45",
87+
"@uirouter/publish-scripts": "2.5.2",
8888
"dts-downlevel": "^0.4.0",
8989
"husky": "^4.2.5",
9090
"jest": "^26.0.1",
@@ -104,5 +104,40 @@
104104
"hooks": {
105105
"pre-commit": "pretty-quick --staged"
106106
}
107+
},
108+
"docgen": {
109+
"publishDir": "_ng1_docs",
110+
"navigation": {
111+
"": [
112+
"UIRouter"
113+
],
114+
"Services": [
115+
"StateService",
116+
"StateRegistry",
117+
"TransitionService",
118+
"UrlService",
119+
"UrlConfig",
120+
"UrlRules"
121+
],
122+
"Interfaces": [
123+
"Ng1StateDeclaration"
124+
],
125+
"Components": [
126+
"uiView",
127+
"UISref",
128+
"UISrefActive"
129+
],
130+
"Other": [
131+
"Transition",
132+
"Trace"
133+
]
134+
},
135+
"include": [
136+
{
137+
"pkg": "@uirouter/core",
138+
"repo": "https://github.com/ui-router/core",
139+
"branch": "master"
140+
}
141+
]
107142
}
108143
}

tsconfig.docgen.json

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"extends": "./tsconfig.json",
3+
"compilerOptions": {
4+
"rootDir": ".",
5+
"baseUrl": ".",
6+
"paths": {
7+
"@uirouter/core": ["src/includes/@uirouter/core/src"],
8+
"@uirouter/core/lib/globals": ["src/includes/@uirouter/core/src/globals"],
9+
"@uirouter/core/lib/state/stateRegistry": ["src/includes/@uirouter/core/src/state/stateRegistry"],
10+
"@uirouter/core/lib/router": ["src/includes/@uirouter/core/src/router"]
11+
}
12+
}
13+
}

tsconfig.typedoc.json

-33
This file was deleted.

typedoc.json

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

0 commit comments

Comments
 (0)