Skip to content

Commit e87616e

Browse files
committed
Added doc generation task and root doc
1 parent 5bc6422 commit e87616e

File tree

2 files changed

+42
-2
lines changed

2 files changed

+42
-2
lines changed

Gruntfile.js

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,14 @@ module.exports = function(grunt) {
5050
autoWatch: false,
5151
singleRun: true
5252
}
53+
},
54+
angular15: {
55+
options: {
56+
keepalive: true,
57+
configFile: 'karma-angular-1.5.conf.js',
58+
autoWatch: false,
59+
singleRun: true
60+
}
5361
}
5462
},
5563

@@ -59,15 +67,33 @@ module.exports = function(grunt) {
5967
prop: 'gitdescribe'
6068
}
6169
}
70+
},
71+
72+
"dgeni-alive": {
73+
options: {
74+
serve: {
75+
port: '10000',
76+
openBrowser: false
77+
},
78+
},
79+
api: {
80+
expand: false,
81+
src: [
82+
'src/**/*.js',
83+
'docs/**/*.ngdoc'
84+
],
85+
dest: 'build/docs'
86+
}
6287
}
63-
88+
6489
});
6590

6691
grunt.loadNpmTasks('grunt-contrib-concat');
6792
grunt.loadNpmTasks('grunt-contrib-uglify');
6893
grunt.loadNpmTasks('grunt-karma');
6994
grunt.loadNpmTasks('grunt-git-describe');
70-
95+
grunt.loadNpmTasks('dgeni-alive');
96+
7197
grunt.registerTask('default', ['concat:prod']);
7298
grunt.registerTask('prod', ['git-describe:run', 'concat:prod', 'uglify']);
7399
};

docs/api/index.ngdoc

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
@ngdoc overview
2+
@name API Reference
3+
@description
4+
5+
# Angular-route-segment API Docs
6+
Welcome to the angular-route-segment API docs page. These pages contain the reference materials for version <strong ng-bind="version"></strong>.
7+
8+
## Modules
9+
10+
## {@link route-segment route-segment (routing module)}
11+
Module defines routing configuration.
12+
13+
## {@link view-segment view-segment (presentation module)}
14+
Module defines routing views and helper components.

0 commit comments

Comments
 (0)