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

Question

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

这是我的步骤：

• 安装apidoc： npm install apidoc -g
• 安装了grunt模块： npm install grunt-apidoc --save-dev
• 将grunt.loadNpmTasks('grunt-apidoc');添加到底部的Gruntfile.js
• 创建了grunt.initConfig文件并放置：

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

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

• 帆升降机
• 咕噜
• grunt default
• node app.js

如果我apidoc -i api/controllers/ -o apidoc/手动运行它，它就能正常运行。

我做错了什么？怎么做？

Answer 1

超级迟到的答案！

根据我修改资产管道的经验，你会更好：

1. 按照问题

安装apidoc和Grunt模块

2. 在`tasks / config / apidoc.js：

   中创建一个新文件

   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
     ]);
   };
   

希望这有助于某人