Skip to content

Commit bf34b01

Browse files
committed
Add YUIDoc support
1 parent 5304cba commit bf34b01

2 files changed

Lines changed: 21 additions & 2 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
node_modules/
22
tests/sandbox/
3+
docs/

Gruntfile.js

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,33 @@ module.exports = function (grunt) {
1515
reporter: 'spec'
1616
},
1717
all: { src: ['tests/*.js'] }
18+
},
19+
20+
yuidoc: {
21+
compile: {
22+
name: '<%= pkg.name %>',
23+
description: '<%= pkg.description %>',
24+
version: '<%= pkg.version %>',
25+
url: '<%= pkg.homepage %>',
26+
options: {
27+
paths: 'src/',
28+
//themedir: 'path/to/custom/theme/',
29+
outdir: 'docs/'
30+
}
31+
}
1832
}
1933

2034
};
2135

2236
grunt.initConfig( opts );
2337
grunt.loadNpmTasks('grunt-simple-mocha');
24-
grunt.registerTask('test', 'Test the FluentLib library.', function( config ) {
38+
grunt.loadNpmTasks('grunt-contrib-yuidoc');
39+
grunt.registerTask('test', 'Test the FluentCV library.', function( config ) {
2540
grunt.task.run( ['simplemocha:all'] );
2641
});
27-
grunt.registerTask('default', [ 'test' ]);
42+
grunt.registerTask('document', 'Generate FluentCV library documentation.', function( config ) {
43+
grunt.task.run( ['yuidoc'] );
44+
});
45+
grunt.registerTask('default', [ 'test', 'yuidoc' ]);
2846

2947
};

0 commit comments

Comments
 (0)