Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Adds task to generate JS docs #2013

Merged
merged 1 commit into from
May 24, 2016
Merged

Adds task to generate JS docs #2013

merged 1 commit into from
May 24, 2016

Conversation

anselmbradford
Copy link
Member

Put together while traveling. Adds initial ability to generate docs from code jsdocs.

Additions

  • Adds gulp docs task to generate code docs for JavaScript.

Testing

  • ./frontend.sh
  • gulp docs
  • open html page in docs/scripts/index.html

Review

Screenshots

screen shot 2016-04-28 at 10 28 53 am

@anselmbradford anselmbradford force-pushed the js_docs branch 2 times, most recently from b82ec05 to 4040e94 Compare April 28, 2016 14:33
@sebworks
Copy link
Contributor

sebworks commented Apr 28, 2016

Is it possible to have the methods organized by their associated files ( in the left hand nav) ?

@anselmbradford
Copy link
Member Author

Seems like it should be possible. The screenshot in https://github.com/documentationjs/documentation-theme-light shows what you're talking about, but when I run that theme through I still get all the methods dumped out at the top level.

@anselmbradford
Copy link
Member Author

I have documentationjs/documentation#412 open to see if we can get an answer.

@sebworks
Copy link
Contributor

ok, looks good other than that. If you want to add a TODO and merge then feel free.

@jimmynotjim
Copy link
Contributor

👍

@anselmbradford anselmbradford force-pushed the js_docs branch 5 times, most recently from 605995e to 15d78d5 Compare May 24, 2016 15:06
@anselmbradford anselmbradford merged commit 7eee89f into flapjack May 24, 2016
@anselmbradford anselmbradford deleted the js_docs branch May 24, 2016 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants