README
grunt-apidoc
About
Generates a RESTful API Documentation with apiDoc.
Generated example documentation at http://apidocjs.com/example/
Installation
npm install grunt-apidoc --save-dev
- Add
grunt.loadNpmTasks('grunt-apidoc');
toGruntfile.js
Configuration
Add the task to your Gruntfile's grunt.initConfig:
apidoc: {
myapp: {
src: "app/",
dest: "apidoc/"
}
}
Use only one src and one dest, apiDoc search in subdirs for files with apidoc-parameters.
Additional options
All apiDoc
options can be used within options-block, see apiDoc configure for details,
or look directly at the code.
src:
Source files directory.dest:
Destination directory, where the documentation will be created.template:
Directory with the template files.options
includeFilters: [ ".*\.js