angularjs通过grunt和ngdocs创建文档

时间:2015-11-10 10:51:59

标签: angularjs gruntjs ngdoc grunt-ngdocs

您好我试图通过grunt和ngdoc为我的ionicframework / angularjs应用程序创建文档。

我已在http://gruntjs.com/getting-started

中安装了首选内容

好吧,如果我现在跑grunt

我明白了:

Running "jshint:gruntfile" (jshint) task
>> 1 file lint free.

Running "jshint:lib_test" (jshint) task
>> 0 files linted. Please check your ignored files.

Running "qunit:files" (qunit) task
Warning: 0/0 assertions ran (0ms) Use --force to continue.

Aborted due to warnings.

由此我无法展示文档。

我的gruntfile看起来像这样:

/*global module:false*/
module.exports = function(grunt) {

  // Project configuration.
  grunt.initConfig({
    // Task configuration.
    jshint: {
      options: {
        curly: true,
        eqeqeq: true,
        immed: true,
        latedef: true,
        newcap: true,
        noarg: true,
        sub: true,
        undef: true,
        unused: true,
        boss: true,
        eqnull: true,
        browser: true,
        globals: {
          jQuery: true
        }
      },
      gruntfile: {
        src: 'Gruntfile.js'
      },
      lib_test: {
        src: ['lib/**/*.js', 'test/**/*.js']
      }
    },
    qunit: {
      files: ['test/**/*.html']
    },

    ngdocs: {
      all: ['src/resources/js/*.js']
    },

    watch: {
      gruntfile: {
        files: '<%= jshint.gruntfile.src %>',
        tasks: ['jshint:gruntfile']
      },
      lib_test: {
        files: '<%= jshint.lib_test.src %>',
        tasks: ['jshint:lib_test', 'qunit']
      }
    }
  });

  // These plugins provide necessary tasks.
  grunt.loadNpmTasks('grunt-contrib-qunit');
  grunt.loadNpmTasks('grunt-contrib-jshint');
  grunt.loadNpmTasks('grunt-contrib-watch');
  grunt.loadNpmTasks('grunt-ngdocs');

  // Default task.
  grunt.registerTask('default', ['jshint', 'qunit']);

  grunt.registerTask('build','Build the application',['ngdocs']);

};

我是创建angularjs文档的新手,那么为此目的的最佳做法是什么?

1 个答案:

答案 0 :(得分:1)

当你只是使用&#39; grunt&#39;从命令行,它将尝试运行Gruntfile.js中的每个任务。

您只想运行ngdocs,因此您应该使用grunt ngdocs作为命令行命令。

您还添加了一个名为&#39; build&#39;的任务,它只运行ngdocs,因此您也可以使用:grunt build