jsdoc-sphinx/template/view-models/home.js

A JSDoc3 template which output ReStructured Text for Sphinx Doc

var _ = require('lodash');
var helper = require('jsdoc/util/templateHelper');
var util = require('../util');
var logger = require('jsdoc/util/logger');

module.exports = home;

/**
 * The Mustache template to render the first page.
 * @param  {object}   context the current context
 * @param  {Function} cb      called after the generation has been done
 */
function home(context, cb) {
  var viewModel = _.extend(
    {
      package: helper.find(context.data, {kind: 'package'})[0]
    }, util.docletChildren(context, null, util.mainDocletKinds),
    util.docletChildren(context, null, util.subDocletKinds),
    util.rstMixin,
    _.pick(context, ['readme'])
  );

  logger.debug('home namespaces', viewModel.namespaces);

  util.view('home.rst', viewModel, cb);
}