Skip to content

Commit 2885551

Browse files
docs(*): Added TypeDoc to the build.
Currently points to a custom build of typedoc at http://github.com/christopherthielen/typedoc
1 parent dddda82 commit 2885551

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

Gruntfile.js

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,13 +143,19 @@ module.exports = function (grunt) {
143143
});
144144

145145
grunt.registerTask('integrate', ['clean', 'build', 'karma:ng12', 'karma:ng13', 'karma:ng14']);
146-
grunt.registerTask('default', ['build', 'karma:unit']);
146+
grunt.registerTask('default', ['build', 'karma:unit', 'docs']);
147147
grunt.registerTask('build', 'Perform a normal build', ['clean', 'ts', 'webpack', 'uglify']);
148148
grunt.registerTask('dist-docs', 'Perform a clean build and generate documentation', ['build', 'ngdocs']);
149149
grunt.registerTask('release', 'Tag and perform a release', ['prepare-release', 'build', 'perform-release']);
150150
grunt.registerTask('dev', 'Run dev server and watch for changes', ['build', 'connect:server', 'karma:background', 'watch']);
151151
grunt.registerTask('sample', 'Run connect server with keepalive:true for sample app development', ['connect:sample']);
152152

153+
grunt.registerTask('docs', 'Generate documentation to _doc', function() {
154+
promising(this,
155+
system('./node_modules/typedoc/bin/typedoc --readme ./README.md --name "UI-Router" --theme default --mode modules --module commonjs --target es5 --out _doc src/params src/path src/resolve src/state src/transition src/url src/view')
156+
);
157+
});
158+
153159
grunt.registerTask('publish-pages', 'Publish a clean build, docs, and sample to github.io', function () {
154160
promising(this,
155161
ensureCleanMaster().then(function () {

package.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,10 @@
7272
"shelljs": "~0.2.6",
7373
"systemjs": "^0.18.4",
7474
"tslint": "=2.5.0",
75-
"typescript": "=1.7.3"
75+
"typedoc": "git://github.com/christopherthielen/typedoc.git#v0.3-uirouter",
76+
"typescript": "=1.7.3",
77+
"webpack": "1.x",
78+
"webpack-dev-server": "1.x"
7679
},
7780
"main": "release/angular-ui-router"
7881
}

0 commit comments

Comments
 (0)