Sails.js + apidocjs + grunt – 自动生成文档

我是Sails.js和Node.js的新手，我在为应用程序创build文档时遇到了问题。

这是我的步骤：

• 通过安装apidoc： npm install apidoc -g
• 安装grunt模块： npm install grunt-apidoc --save-dev
• 添加grunt.loadNpmTasks('grunt-apidoc'); Gruntfile.js
• 创buildgrunt.initConfig文件，并把：

apidoc: { myapp: { src: "api/controllers/", dest: "apidoc/" } }

然后我试图运行多个东西，没有一个产生我的api文档：

• 帆升降机
• 咕噜
• 咕噜默认
• 节点app.js

如果我通过apidoc -i api/controllers/ -o apidoc/手动运行它，它工作正常。

我究竟做错了什么？ 怎么做？

Answer 1

超晚回答！

从我修改资产pipe道的经验来看，你会更好：

1. 在问题中安装apidoc和Grunt模块

2. 在`tasks / config / apidoc.js中创build一个新文件：

    module.exports = function (grunt) { grunt.config.set('apidoc', { myapp: { src: "api/controllers/", dest: "apidoc/" } }); grunt.loadNpmTasks('grunt-apidoc'); }; 

3. 编辑tasks/register/compileAssets.js （或任何你想要运行的任务）：

    module.exports = function (grunt) { grunt.registerTask('compileAssets', [ 'clean:dev', 'jst:dev', 'less:dev', 'copy:dev', 'coffee:dev', 'apidoc:myapp' // <-- This will now run every time your assets are compiled ]); }; 

希望这有助于某人