habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improved the format of the docs a bit and fixed the generator

Browse Source
This commit is contained in:
Spencer Alger
2013-12-12 21:43:47 -07:00
parent aa831043e8
commit 22c675e250
3 changed files with 17 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
scripts/_steps.js
View File

@ -76,7 +76,9 @@ module.exports = function (argv, steps) {
}); });
}, },
runInModule: function (params, done) { runInModule: function (params, done) {
params = params || {};
params.cwd = path.resolve(__dirname, '../');
this.run(params, done);
}, },
copy: function (params, done) { copy: function (params, done) {
var from = params.from; var from = params.from;
@ -125,7 +127,7 @@ module.exports = function (argv, steps) {
}); });
if (typeof task === 'function') { if (typeof task === 'function') {
task.apply(null, args); task.apply(tasks, args);
} else { } else {
throw new Error(taskName + ' is an invalid task, does not resolve to a function.'); throw new Error(taskName + ' is an invalid task, does not resolve to a function.');
} }

2
scripts/export_docs.js
View File

@ -14,7 +14,7 @@ var argv = require('optimist')
require('./_steps')(argv, [ require('./_steps')(argv, [
['runInModule', { ['runInModule', {
cmd: 'node', cmd: 'node',
args: [path.join(__dirname, './generate'), '--force'] args: ['scripts/generate', '--force']
}], }],
['copy', { ['copy', {
from: path.join(__dirname, '../docs/_methods.jade'), from: path.join(__dirname, '../docs/_methods.jade'),

25
scripts/generate/templates/api_methods.tmpl
View File

@ -4,7 +4,7 @@ var actionId = action.name.toLowerCase().replace(/[^\w]+/g, '-');
%> %>
h3#<%= actionId %>.fn h2#<%= actionId %>.fn
span.name <%= action.name %> span.name <%= action.name %>
span.args (params, [callback]) span.args (params, [callback])
a.perma(href="api.html#<%= actionId %>", title="Permalink") a.perma(href="api.html#<%= actionId %>", title="Permalink")
@ -16,21 +16,20 @@ a.esdoc(href="<%= action.docUrl %>", title="Endpoint Docs")
return (i > 0 ? ' | ' : '') + line; return (i > 0 ? ' | ' : '') + line;
}).join('\n') %> }).join('\n') %>
h4 Params: <% if (_.size(action.allParams)) { %>
ul.params.api h3 Params:
dl.params.api
<% _.each(action.allParams, function (param, paramName) { %> <% _.each(action.allParams, function (param, paramName) { %>
li. dt: dfn: code <%= paramWithDefault(paramName, param.default) %>
<code class="name"><%= paramWithDefault(paramName, param.default) %></code> <span class="types"><%= dd.
paramType(param.type) %></span> <span class="types"><%= paramType(param.type) %></span>
<%= indent(param.description || '', 4) %><% <%= indent(param.description || '', 4) %><%
}); %> }); %>
li <a href="#api-conventions-params">the usual</a> <% } %>
p.
Default method: <%= action.spec.method || 'GET' %><br>
Includes <a href="#api-conventions-return">the usual</a>
h4 Method: <code><%= action.spec.method || 'GET' %></code> include _examples/<%= action.name %>.jade<%
h4 Returns:
p: a(href="#api-conventions-return") the usual
include _examples/<%= action.name %><%
}); });
%> %>