node.js - 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: { 我的应用程序:{ src:“api/ Controller /”， 目标:“apidoc/” } }

然后我尝试运行多个东西，但它们都没有生成我的 api 文档:

• sails 升降机
• 咕噜声
• 默认的咕噜声
• Node app.js

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

我做错了什么？怎么做？

Answer 1

super 迟到的答案!

根据我修改 Assets 管道的经验，您的情况会更好:

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

希望这对某人有帮助