Added ngdocs configuration

Carlos Purificação
1 parent 7b837dbc
Showing 5 changed files with 48 additions and 2 deletions Show diff stats
.gitignore
gulp/build.js
gulp/conf.js
gulpfile.js
package.json
 node_modules/
 bower_components/
 coverage/
+docs/
 .sass-cache/
 .idea/
 .tmp/
@@ -98,4 +98,8 @@ gulp.task(&#39;clean&#39;, function () {
   return $.del([path.join(conf.paths.dist, '/'), path.join(conf.paths.tmp, '/')]);
 });
  
+gulp.task('clean-docs', [], function() {
+    return $.del([path.join(conf.paths.docs, '/')]);    
+});
+
 gulp.task('build', ['html', 'fonts', 'other']);
@@ -15,7 +15,8 @@ exports.paths = {
   src: 'src',
   dist: 'dist',
   tmp: '.tmp',
-  e2e: 'e2e'
+  e2e: 'e2e',
+  docs: 'docs'
 };
  
 /**
@@ -27,3 +27,42 @@ wrench.readdirSyncRecursive(&#39;./gulp&#39;).filter(function(file) {
 gulp.task('default', ['clean'], function () {
   gulp.start('build');
 });
+
+gulp.task('ngdocs', ['clean-docs'], function () {
+  var gulpDocs = require('gulp-ngdocs');
+  var options = {
+    scripts: [
+      'bower_components/angular/angular.min.js',
+      'bower_components/angular/angular.min.js.map',
+      'bower_components/angular-animate/angular-animate.min.js',
+      'bower_components/angular-animate/angular-animate.min.js.map'
+      //'bower_components/angular/angular.js'
+    ],
+    html5Mode: true,
+    startPage: '/',
+    title: "Noosfero Angular Theme Documentation",
+    //image: "path/to/my/image.png",
+    //imageLink: "http://my-domain.com",
+    titleLink: "/",
+    loadDefaults: {
+        angular: false,
+        angularAnimate: false
+    }
+  }
+  return gulpDocs.sections({
+    api: {
+      glob:[
+          //'src/**/*.js', '!src/noosfero.js', '!src/noosfero-specs.js'
+          //'src/noosfero.js'
+          'src/**/*.ts'
+      ],//, '!src/**/*.spec.js'],
+      api: true,
+      title: 'API Documentation'
+    },
+    tutorial: {
+      glob: ['content/tutorial/*.ngdoc'],
+      title: 'Tutorial'
+    }
+  }).pipe(gulpDocs.process(options)).pipe(gulp.dest('./docs'));
+});
+
@@ -4,7 +4,7 @@
   "dependencies": {
     "angular": "^1.5.0",
     "angular-mock": "^1.0.0",
-    "moment": "^2.11.2"
+    "moment": "^2.11.2"    
   },
   "scripts": {
     "webpack": "webpack",
@@ -41,6 +41,7 @@
     "gulp-minify-css": "~1.2.1",
     "gulp-minify-html": "~1.0.4",
     "gulp-ng-annotate": "~1.1.0",
+    "gulp-ngdocs": "0.2.13",
     "gulp-protractor": "~1.0.0",
     "gulp-rename": "~1.2.2",
     "gulp-replace": "~0.5.4",
1	1	node_modules/
2	2	bower_components/
3	3	coverage/
	4	+docs/
4	5	.sass-cache/
5	6	.idea/
6	7	.tmp/
...	...
...	...	@@ -98,4 +98,8 @@ gulp.task('clean', function () {
98	98	return $.del([path.join(conf.paths.dist, '/'), path.join(conf.paths.tmp, '/')]);
99	99	});
100	100
	101	+gulp.task('clean-docs', [], function() {
	102	+ return $.del([path.join(conf.paths.docs, '/')]);
	103	+});
	104	+
101	105	gulp.task('build', ['html', 'fonts', 'other']);
...	...
...	...	@@ -15,7 +15,8 @@ exports.paths = {
15	15	src: 'src',
16	16	dist: 'dist',
17	17	tmp: '.tmp',
18		- e2e: 'e2e'
	18	+ e2e: 'e2e',
	19	+ docs: 'docs'
19	20	};
20	21
21	22	/**
...	...
...	...	@@ -27,3 +27,42 @@ wrench.readdirSyncRecursive('./gulp').filter(function(file) {
27	27	gulp.task('default', ['clean'], function () {
28	28	gulp.start('build');
29	29	});
	30	+
	31	+gulp.task('ngdocs', ['clean-docs'], function () {
	32	+ var gulpDocs = require('gulp-ngdocs');
	33	+ var options = {
	34	+ scripts: [
	35	+ 'bower_components/angular/angular.min.js',
	36	+ 'bower_components/angular/angular.min.js.map',
	37	+ 'bower_components/angular-animate/angular-animate.min.js',
	38	+ 'bower_components/angular-animate/angular-animate.min.js.map'
	39	+ //'bower_components/angular/angular.js'
	40	+ ],
	41	+ html5Mode: true,
	42	+ startPage: '/',
	43	+ title: "Noosfero Angular Theme Documentation",
	44	+ //image: "path/to/my/image.png",
	45	+ //imageLink: "http://my-domain.com",
	46	+ titleLink: "/",
	47	+ loadDefaults: {
	48	+ angular: false,
	49	+ angularAnimate: false
	50	+ }
	51	+ }
	52	+ return gulpDocs.sections({
	53	+ api: {
	54	+ glob:[
	55	+ //'src/*/.js', '!src/noosfero.js', '!src/noosfero-specs.js'
	56	+ //'src/noosfero.js'
	57	+ 'src/*/.ts'
	58	+ ],//, '!src/*/.spec.js'],
	59	+ api: true,
	60	+ title: 'API Documentation'
	61	+ },
	62	+ tutorial: {
	63	+ glob: ['content/tutorial/*.ngdoc'],
	64	+ title: 'Tutorial'
	65	+ }
	66	+ }).pipe(gulpDocs.process(options)).pipe(gulp.dest('./docs'));
	67	+});
	68	+
...	...
...	...	@@ -4,7 +4,7 @@
4	4	"dependencies": {
5	5	"angular": "^1.5.0",
6	6	"angular-mock": "^1.0.0",
7		- "moment": "^2.11.2"
	7	+ "moment": "^2.11.2"
8	8	},
9	9	"scripts": {
10	10	"webpack": "webpack",
...	...	@@ -41,6 +41,7 @@
41	41	"gulp-minify-css": "~1.2.1",
42	42	"gulp-minify-html": "~1.0.4",
43	43	"gulp-ng-annotate": "~1.1.0",
	44	+ "gulp-ngdocs": "0.2.13",
44	45	"gulp-protractor": "~1.0.0",
45	46	"gulp-rename": "~1.2.2",
46	47	"gulp-replace": "~0.5.4",
...	...