documentationjs / grunt-documentation Goto Github PK

Greenkeeper updated the dep here:

5b5675a

but when I install grunt-documentation I still get 4.0.0-rc.0

Hello!

I've realized that when using the default format, the documentation will be stored in the given destination folder. If I choose "md" as format, it will be stored at ProjectRoot/API.md

Best,
Simon

Hi @SunboX, I just tried your new theme example but it fails for me:
doing $grunt --stack --verbose

trace:

Initializing
Command-line options: --stack, --verbose

Reading "Gruntfile.js" Gruntfile...OK

Registering Gruntfile tasks.
Initializing config...OK

Registering "../../tasks" tasks.
Loading "documentation.js" tasks...OK
+ documentation
Loading "Gruntfile.js" tasks...OK
+ default

No tasks specified, running default tasks.
Running tasks: default

Running "default" task

Running "documentation" task

Running "documentation:default" (documentation) task
Verifying property documentation.default exists in config...OK
Files: src/ColorPoint.js -> ColorPoint.js
Files: src/Point.js -> Point.js
Options: format="html", shallow=false, github=false, access=["public","protected","undefined"], order=[], destination="docs", theme="/home/jtorres/Projects/grunt-documentation/demo/theme/documentation-theme-light"
>> TypeError: object is not a function
Warning: Task "documentation:default" failed. Use --force to continue.
Error: Task "documentation:default" failed.
    at Task.<anonymous> (/home/jtorres/Projects/grunt-documentation/demo/theme/node_modules/grunt/lib/util/task.js:205:15)
    at null._onTimeout (/home/jtorres/Projects/grunt-documentation/demo/theme/node_modules/grunt/lib/util/task.js:241:33)
    at Timer.listOnTimeout [as ontimeout] (timers.js:110:15)

Aborted due to warnings.

This grunt task now exits with no error message, and does not produce output file. I believe it is most likely because of the move to promises in https://github.com/documentationjs/documentation.

The grunt task is no longer synchronous, and exits before completion.

At this moment, options.order is not working. I have seen that sort function is using options.toc instead.
https://github.com/documentationjs/documentation/blob/6cbf4bd1d8945e7007ba925a2831ea6234123234/lib/sort.js#L15
Is there a different way to handle it? I can create a PR.

Getting issue below, have documentation installed both globally and locally. Using in windows 7. Any ideas?

Running "documentation:default" (documentation) task
Verifying property documentation.default exists in config...OK
Files: src/scripts/components/TemplateApp.js -> components/TemplateApp.js
Files: src/scripts/index.js -> index.js
Files: src/scripts/reducers/rootReducer.js -> reducers/rootReducer.js
Files: src/scripts/store/TemplateStore.js -> store/TemplateStore.js
Options: format="html", shallow=false, github=false, access=["public","protected","undefined"], order=[], destin
ation="docs"
Warning: documentation is not a function Use --force to continue.

It would be really nice if you could output to multiple formats at the same time, like HTML for a website and Markdown for GitHub.

Want to make this the official documentation grunt binding? I'll add you as an admin for the organization and you could transfer this over, and it would have a shoutout on the http://documentation.js.org/ website