Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Creating Automatic API Documentation via Grunt #689

Closed
wants to merge 3 commits into from
Closed

Creating Automatic API Documentation via Grunt #689

wants to merge 3 commits into from

Conversation

ghost
Copy link

@ghost ghost commented Aug 16, 2013

using a grunt plugin "grunt-spidox" ive set up a grunt task to automatically generate docs/playerapi.md separate from docs/api.md (i guess the human readable version) docs/playerapi.md basically contains a list of methods and descriptions generated by running grunt apidox

@heff
Copy link
Member

heff commented Aug 19, 2013

Very cool. :) I've actually been working on this exact same thing, though thru a slightly different approach using markdox.

This is an example of what I'm aiming for, and it's pretty close.
https://github.com/heff/video-js/blob/feature/doc-generator/docs/example.md

I'm going to dig into your example and try to determine the benefits of both. Thanks for pointing out apidox. Somehow I didn't find that in all my searching for dox -> markdown support.

@ghost
Copy link
Author

ghost commented Aug 19, 2013

no problem, i always tend to find the coolest things when im hacking around with the video.js source :)

* 'master' of https://github.com/videojs/video.js:
  Adding line to CHANGELOG
  Close GH-683: gruntfile: removed new line symbol from output_wrapper. fixes #679.
@heff
Copy link
Member

heff commented Nov 25, 2013

Thanks again for this. Generated docs were added in #801.

@heff heff closed this Nov 25, 2013
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant