Skip to content

Commit bdb4513

Browse files
docs(*): use publish-scripts to generate/publish docs
1 parent 3cc7252 commit bdb4513

File tree

4 files changed

+108
-68
lines changed

4 files changed

+108
-68
lines changed

package.json

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,7 @@
1414
"test:downstream": "npm run build && test_downstream_projects",
1515
"debug": "karma start --singleRun=false --autoWatch=true --autoWatchInterval=1 --browsers=Chrome",
1616
"package": "npm run build",
17-
"docs": "typedoc --tsconfig tsconfig.typedoc.json --readme README.md --name '@uirouter/angular' --theme node_modules/ui-router-typedoc-themes/bin/default --out _doc --internal-aliases internal,coreapi,ng2api --external-aliases internalapi,external --navigation-label-globals @uirouter/angular",
18-
"publishdocs": "npm run docs && node --harmony scripts/publishdocs.js",
17+
"docs": "generate_docs && publish_docs",
1918
"prepublishOnly": "npm run build",
2019
"changelog": "update_changelog --include-core",
2120
"artifacts": "artifact_tagging"
@@ -67,7 +66,7 @@
6766
"@angular/router": "^4.0.0",
6867
"@types/jasmine": "2.8.6",
6968
"@types/jquery": "3.3.0",
70-
"@uirouter/publish-scripts": "2.2.10",
69+
"@uirouter/publish-scripts": "file:.yalc/@uirouter/publish-scripts",
7170
"jasmine-core": "2.99.0",
7271
"karma": "2.0.0",
7372
"karma-chrome-launcher": "2.2.0",
@@ -87,12 +86,7 @@
8786
"ts-loader": "3.4.0",
8887
"tslib": "1.9.0",
8988
"tslint": "5.9.1",
90-
"typedoc": "0.9.0",
91-
"typedoc-plugin-external-module-name": "1.0.10",
92-
"typedoc-plugin-internal-external": "1.0.10",
93-
"typedoc-plugin-ui-router": "1.0.6",
9489
"typescript": "2.6.2",
95-
"ui-router-typedoc-themes": "1.0.2",
9690
"webpack": "3.10.0",
9791
"webpack-dev-server": "2.11.1",
9892
"zone.js": "0.8.20"

tsconfig.typedoc.json

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

typedoc.json

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"compilerOptions": {
3+
"emitDecoratorMetadata": true,
4+
"experimentalDecorators": true,
5+
"module": "commonjs",
6+
"target": "es5",
7+
"allowSyntheticDefaultImports": true,
8+
"outDir": "build/es5",
9+
"declaration": false,
10+
"sourceMap": false,
11+
"importHelpers": true
12+
},
13+
"typedoc": {
14+
"publishDir": "_ng2_docs",
15+
"include": [
16+
{
17+
"package": "@uirouter/core",
18+
"repo": "https://github.com/ui-router/core.git",
19+
"entry": "src/index.ts"
20+
}
21+
],
22+
"generateOptions": {
23+
"tsconfig": "typedoc.json",
24+
"readme": "README.md",
25+
"name": "@uirouter/angular",
26+
"theme": "node_modules/ui-router-typedoc-themes/bin/default",
27+
"out": "_doc",
28+
"internal-aliases": "internal,coreapi,ng2api",
29+
"external-aliases": "internalapi,external",
30+
"navigation-label-globals": "@uirouter/angular"
31+
}
32+
},
33+
"files": [
34+
"src/index.ts",
35+
"../core/src/index.ts",
36+
"node_modules/typedoc/node_modules/typescript/lib/lib.es6.d.ts"
37+
]
38+
}

yarn.lock

Lines changed: 68 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -60,19 +60,31 @@
6060
dependencies:
6161
tsickle "^0.21.0"
6262

63-
64-
version "4.0.0"
65-
resolved "https://registry.yarnpkg.com/@types/fs-extra/-/fs-extra-4.0.0.tgz#1dd742ad5c9bce308f7a52d02ebc01421bc9102f"
63+
"@types/events@*":
64+
version "1.1.0"
65+
resolved "https://registry.yarnpkg.com/@types/events/-/events-1.1.0.tgz#93b1be91f63c184450385272c47b6496fd028e02"
66+
67+
"@types/fs-extra@^4.0.0":
68+
version "4.0.7"
69+
resolved "https://registry.yarnpkg.com/@types/fs-extra/-/fs-extra-4.0.7.tgz#02533262386b5a6b9a49797dc82feffdf269140a"
70+
dependencies:
71+
"@types/node" "*"
72+
73+
"@types/glob@*":
74+
version "5.0.35"
75+
resolved "https://registry.yarnpkg.com/@types/glob/-/glob-5.0.35.tgz#1ae151c802cece940443b5ac246925c85189f32a"
6676
dependencies:
77+
"@types/events" "*"
78+
"@types/minimatch" "*"
6779
"@types/node" "*"
6880

69-
70-
version "4.0.31"
71-
resolved "https://registry.yarnpkg.com/@types/handlebars/-/handlebars-4.0.31.tgz#a7fba66fafe42713aee88eeca8db91192efe6e72"
81+
"@types/handlebars@^4.0.31":
82+
version "4.0.36"
83+
resolved "https://registry.yarnpkg.com/@types/handlebars/-/handlebars-4.0.36.tgz#ff57c77fa1ab6713bb446534ddc4d979707a3a79"
7284

73-
74-
version "9.1.8"
75-
resolved "https://registry.yarnpkg.com/@types/highlight.js/-/highlight.js-9.1.8.tgz#d227f18bcb8f3f187e16965f2444859a04689758"
85+
"@types/highlight.js@^9.1.8":
86+
version "9.12.2"
87+
resolved "https://registry.yarnpkg.com/@types/highlight.js/-/highlight.js-9.12.2.tgz#6ee7cd395effe5ec80b515d3ff1699068cd0cd1d"
7688

7789
7890
version "2.8.6"
@@ -82,47 +94,57 @@
8294
version "3.3.0"
8395
resolved "https://registry.yarnpkg.com/@types/jquery/-/jquery-3.3.0.tgz#6316ac20a1a13c5d521a2dc661befc7184f73f5b"
8496

85-
"@types/[email protected].74":
86-
version "4.14.74"
87-
resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.74.tgz#ac3bd8db988e7f7038e5d22bd76a7ba13f876168"
97+
"@types/lodash@^4.14.37":
98+
version "4.14.101"
99+
resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.101.tgz#512f6c9e1749890f4d024e98cb995a63f562d458"
88100

89-
"@types/marked@0.3.0":
90-
version "0.3.0"
91-
resolved "https://registry.yarnpkg.com/@types/marked/-/marked-0.3.0.tgz#583c223dd33385a1dda01aaf77b0cd0411c4b524"
101+
"@types/marked@0.0.28":
102+
version "0.0.28"
103+
resolved "https://registry.yarnpkg.com/@types/marked/-/marked-0.0.28.tgz#44ba754e9fa51432583e8eb30a7c4dd249b52faa"
92104

93-
105+
"@types/minimatch@*":
106+
version "3.0.3"
107+
resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.3.tgz#3dca0e3f33b200fc7d1139c0cd96c1268cadfd9d"
108+
109+
"@types/minimatch@^2.0.29":
94110
version "2.0.29"
95111
resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-2.0.29.tgz#5002e14f75e2d71e564281df0431c8c1b4a2a36a"
96112

97113
"@types/node@*":
98114
version "8.0.57"
99115
resolved "https://registry.yarnpkg.com/@types/node/-/node-8.0.57.tgz#e5d8b4dc112763e35cfc51988f4f38da3c486d99"
100116

101-
102-
version "0.7.0"
103-
resolved "https://registry.yarnpkg.com/@types/shelljs/-/shelljs-0.7.0.tgz#229c157c6bc1e67d6b990e6c5e18dbd2ff58cff0"
117+
"@types/shelljs@^0.7.0":
118+
version "0.7.8"
119+
resolved "https://registry.yarnpkg.com/@types/shelljs/-/shelljs-0.7.8.tgz#4b4d6ee7926e58d7bca448a50ba442fd9f6715bd"
104120
dependencies:
121+
"@types/glob" "*"
105122
"@types/node" "*"
106123

107124
"@uirouter/[email protected]":
108125
version "5.0.16"
109126
resolved "https://registry.yarnpkg.com/@uirouter/core/-/core-5.0.16.tgz#c6f9e2041df1b6ad3bc28b089e55241a1cb4610f"
110127

111-
"@uirouter/[email protected]":
112-
version "2.2.10"
113-
resolved "https://registry.yarnpkg.com/@uirouter/publish-scripts/-/publish-scripts-2.2.10.tgz#08db3cfeacb1961b7668eb55d70956a7853aea28"
128+
"@uirouter/publish-scripts@file:.yalc/@uirouter/publish-scripts":
129+
version "2.2.10-20dc33e9"
114130
dependencies:
115131
conventional-changelog "^1.1.4"
116132
conventional-changelog-ui-router-core "^1.4.2"
117133
find-parent-dir "^0.3.0"
118134
git-semver-tags "^1.2.1"
135+
lodash "^4.17.5"
119136
npm-run-all "^4.1.1"
120137
open "^0.0.5"
121138
readline-sync "^1.4.7"
122139
shelljs "^0.7.8"
123140
shx "^0.2.2"
124141
tmp "^0.0.33"
125142
tweak-sourcemap-paths "0.0.3"
143+
typedoc "0.8.0"
144+
typedoc-plugin-external-module-name "^1.1.1"
145+
typedoc-plugin-internal-external "^1.0.10"
146+
typedoc-plugin-ui-router "^1.0.6"
147+
ui-router-typedoc-themes "^1.0.2"
126148
yargs "^9.0.1"
127149

128150
"@uirouter/[email protected]":
@@ -3324,10 +3346,14 @@ lodash@^3.8.0:
33243346
version "3.10.1"
33253347
resolved "https://registry.yarnpkg.com/lodash/-/lodash-3.10.1.tgz#5bf45e8e49ba4189e17d482789dfd15bd140b7b6"
33263348

3327-
lodash@^4.0.0, lodash@^4.0.1, lodash@^4.13.1, lodash@^4.14.0, lodash@^4.15.0, lodash@^4.17.2, lodash@^4.17.4, lodash@^4.2.1, lodash@^4.5.0:
3349+
lodash@^4.0.0, lodash@^4.0.1, lodash@^4.14.0, lodash@^4.15.0, lodash@^4.17.2, lodash@^4.17.4, lodash@^4.2.1, lodash@^4.5.0:
33283350
version "4.17.4"
33293351
resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.4.tgz#78203a4d1c328ae1d86dca6460e369b57f4055ae"
33303352

3353+
lodash@^4.13.1, lodash@^4.17.5:
3354+
version "4.17.5"
3355+
resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.5.tgz#99a92d65c0272debe8c96b6057bc8fbfa3bed511"
3356+
33313357
log4js@^2.3.9:
33323358
version "2.4.1"
33333359
resolved "https://registry.yarnpkg.com/log4js/-/log4js-2.4.1.tgz#b0c4e88133e0e3056afdc6f91f7f377576158778"
@@ -3430,8 +3456,8 @@ map-visit@^1.0.0:
34303456
object-visit "^1.0.0"
34313457

34323458
marked@^0.3.5:
3433-
version "0.3.7"
3434-
resolved "https://registry.yarnpkg.com/marked/-/marked-0.3.7.tgz#80ef3bbf1bd00d1c9cfebe42ba1b8c85da258d0d"
3459+
version "0.3.12"
3460+
resolved "https://registry.yarnpkg.com/marked/-/marked-0.3.12.tgz#7cf25ff2252632f3fe2406bde258e94eee927519"
34353461

34363462
md5.js@^1.3.4:
34373463
version "1.3.4"
@@ -5603,29 +5629,29 @@ typedoc-default-themes@^0.5.0:
56035629
version "0.5.0"
56045630
resolved "https://registry.yarnpkg.com/typedoc-default-themes/-/typedoc-default-themes-0.5.0.tgz#6dc2433e78ed8bea8e887a3acde2f31785bd6227"
56055631

5606-
typedoc-plugin-external-module-name@1.0.10:
5607-
version "1.0.10"
5608-
resolved "https://registry.yarnpkg.com/typedoc-plugin-external-module-name/-/typedoc-plugin-external-module-name-1.0.10.tgz#f97c1df450d9ec75bf06b72bf3f9a12382184135"
5632+
typedoc-plugin-external-module-name@^1.1.1:
5633+
version "1.1.1"
5634+
resolved "https://registry.yarnpkg.com/typedoc-plugin-external-module-name/-/typedoc-plugin-external-module-name-1.1.1.tgz#0ef2d6a760b42c703519c474258b6f062983aa83"
56095635

5610-
5636+
typedoc-plugin-internal-external@^1.0.10:
56115637
version "1.0.10"
56125638
resolved "https://registry.yarnpkg.com/typedoc-plugin-internal-external/-/typedoc-plugin-internal-external-1.0.10.tgz#df9fd6ee1743f009c39b8746a3c26edc36ce8bcd"
56135639

5614-
5640+
typedoc-plugin-ui-router@^1.0.6:
56155641
version "1.0.6"
56165642
resolved "https://registry.yarnpkg.com/typedoc-plugin-ui-router/-/typedoc-plugin-ui-router-1.0.6.tgz#6d452d499d1bd35701ebfdeb2beee670d8530e8b"
56175643

5618-
typedoc@0.9.0:
5619-
version "0.9.0"
5620-
resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.9.0.tgz#159bff7c7784ce5b91d86f3e4cc8928e62040957"
5621-
dependencies:
5622-
"@types/fs-extra" "4.0.0"
5623-
"@types/handlebars" "4.0.31"
5624-
"@types/highlight.js" "9.1.8"
5625-
"@types/lodash" "4.14.74"
5626-
"@types/marked" "0.3.0"
5627-
"@types/minimatch" "2.0.29"
5628-
"@types/shelljs" "0.7.0"
5644+
typedoc@0.8.0:
5645+
version "0.8.0"
5646+
resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.8.0.tgz#d7172bc6a29964f451b7609c005beadadefe2361"
5647+
dependencies:
5648+
"@types/fs-extra" "^4.0.0"
5649+
"@types/handlebars" "^4.0.31"
5650+
"@types/highlight.js" "^9.1.8"
5651+
"@types/lodash" "^4.14.37"
5652+
"@types/marked" "0.0.28"
5653+
"@types/minimatch" "^2.0.29"
5654+
"@types/shelljs" "^0.7.0"
56295655
fs-extra "^4.0.0"
56305656
handlebars "^4.0.6"
56315657
highlight.js "^9.0.0"
@@ -5673,7 +5699,7 @@ uglifyjs-webpack-plugin@^0.4.6:
56735699
uglify-js "^2.8.29"
56745700
webpack-sources "^1.0.1"
56755701

5676-
5702+
ui-router-typedoc-themes@^1.0.2:
56775703
version "1.0.2"
56785704
resolved "https://registry.yarnpkg.com/ui-router-typedoc-themes/-/ui-router-typedoc-themes-1.0.2.tgz#3274960b8ee61e026b405ce3afcd9a2925992861"
56795705

0 commit comments

Comments
 (0)