Skip to content

Commit

Permalink
apidoc implementation
Browse files Browse the repository at this point in the history
  • Loading branch information
Pierre-Gilles committed Oct 27, 2016
1 parent 55eb1fa commit beb9e3c
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
################################################

#config/googleapi.js
apidoc



Expand Down
6 changes: 6 additions & 0 deletions apidoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"name": "gladys",
"version": "0.1.0",
"description": "Gladys REST API documentation",
"title": "Gladys REST API documentation"
}
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@
"suncalc": "^1.7.0"
},
"devDependencies": {
"grunt-apidoc": "^0.11.0",
"grunt-contrib-csslint": "^1.0.0",
"grunt-mocha-istanbul": "^5.0.1",
"istanbul": "^0.4.2",
Expand Down
14 changes: 14 additions & 0 deletions tasks/config/apidoc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
/**
* Generate documentation
*/
module.exports = function(grunt) {

grunt.config.set('apidoc', {
myapp: {
src: "api/",
dest: "apidoc/"
}
});

grunt.loadNpmTasks('grunt-apidoc');
};
3 changes: 3 additions & 0 deletions tasks/register/generateDoc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = function (grunt) {
grunt.registerTask('generate-doc', ['apidoc']);
};

0 comments on commit beb9e3c

Please sign in to comment.