Lack of proper documentation about sails-apidocs HOT 8 OPEN

Any documentation to configure and use this module?

from sails-apidocs.

Yes

from sails-apidocs.

Hi sorry the documentation is pretty lacking. I've been meaning to get around to cleaning it up to make it more useful and adding some features, but I won't be able to really over the next month as I'm currently travelling with sporadic internet.

If I remember correctly there are some comments in the source code that should be helpful.

On Jun 6, 2015, at 5:52 AM, anandmahajan [email protected] wrote:

Yes

—
Reply to this email directly or view it on GitHub.

from sails-apidocs.

Essentially the program takes a config object. in lib/config.js there are some defaults to specify where to look for your API files (defaults to sails structure). You can set the 'exclude' option to an array of strings of API resources to exclude from the API.

It compiles using dox and doxx style jshint markup, so checking those out is a good place to start.

Sorry I can't be of more help right now, thanks for checking out the project, and I'll put some time into next month!

On Jun 6, 2015, at 5:52 AM, anandmahajan [email protected] wrote:

Yes

—
Reply to this email directly or view it on GitHub.

from sails-apidocs.

OK thx. I will try that!

from sails-apidocs.

Hi! Thanks for this but unfortunately I could not even figure how to hook up the module with sails and gen anything... Should I add a task to call up the module?

from sails-apidocs.

I just call it from my bootstrap file, using a 'require' statement to load the model.

I just got back from a field assignment. I'll try and devote some time to this next week.

On Jul 16, 2015, at 7:04 AM, Armel Larcier [email protected] wrote:

Hi! Thanks for this but unfortunately I could not even figure how to hook up the module with sails and gen anything... Should I add a task to call up the module?

—
Reply to this email directly or view it on GitHub.

from sails-apidocs.

EDITED

Maybe this will help someone. I put the following in my ./config/bootstrap.js. I like to leave everything in node_modules unmodified, so this is what I did:

require('sails-apidocs')({
        template: process.cwd() + '/lib/sails-apidocs-views/template.jade',
        targetDir: process.cwd() + '/assets/docs/api'
});

It runs and generates output, but no documentation is extracted. Briefly looking through index.js it seems to process routes, but not blueprints, controllers and models. Also, any routes are skipped near the comment: TODO: Parse the string.

Any other ideas would be welcome.

from sails-apidocs.