diff --git a/.gitignore b/.gitignore index 544127c52..1d8b7fac1 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,7 @@ dist .tmp .sass-cache wallaby.conf.js +docs/* +!docs/img/ +!.gitkeep + diff --git a/docs/.gitkeep b/docs/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/docs/img/.gitkeep b/docs/img/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/docs/img/CIViC_logo_sm.png b/docs/img/CIViC_logo_sm.png new file mode 100644 index 000000000..7ea23877a Binary files /dev/null and b/docs/img/CIViC_logo_sm.png differ diff --git a/gulp/docs.js b/gulp/docs.js new file mode 100644 index 000000000..b65d7f228 --- /dev/null +++ b/gulp/docs.js @@ -0,0 +1,24 @@ +'use strict'; + +var gulp = require('gulp'); +var gulpDocs = require('gulp-ngdocs'); + +gulp.task('docs:generate', [], function () { + var options = { + scripts: [ + 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.2.28/angular.min.js', + 'https://cdnjs.cloudflare.com/ajax/libs/angular.js/1.2.28/angular-animate.min.js' + ], + html5Mode: false, + startPage: '/docs', + title: "CIViC Client Developer Documentation", + image: "CIViC_logo_sm.png", + imageLink: "http://civicdb.org", + titleLink: "/docs", + discussions: true + }; + + return gulp.src('src/{app,components}/**/*.js') + .pipe(gulpDocs.process(options)) + .pipe(gulp.dest('./docs')); +}); diff --git a/gulp/server.js b/gulp/server.js index 6ea6b4401..b6893585a 100644 --- a/gulp/server.js +++ b/gulp/server.js @@ -33,6 +33,7 @@ gulp.task('serve', ['images', 'fonts', 'watch'], function () { connectInit([ './src', './.tmp', + './docs', path.resolve('./') // include root (kludge necessary to make bower_components available where index.html expects them) ], true); }); diff --git a/package.json b/package.json index 9cec60837..9714d9a7a 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,6 @@ "type": "git", "url": "git://github.com/genome/civic-client" }, - "dependencies": {}, "devDependencies": { "browser-sync": "^1.3.6", "browserify": "^9.0.3", @@ -33,6 +32,7 @@ "gulp-minify-html": "^0.1.3", "gulp-ng-annotate": "^0.5.2", "gulp-ng-html2js": "^0.1.6", + "gulp-ngdocs": "^0.2.10", "gulp-protractor": "^0.0.11", "gulp-replace": "^0.4.0", "gulp-rev": "^1.1.0",