-
Notifications
You must be signed in to change notification settings - Fork 49
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
Use autogenerated function documentation #9
Comments
We could also use sphinx-js and ReadTheDocs. There's a description in the example. What do you think? |
If we use GitHub pages instead of the wiki for documentation, we should generate the jsdoc to a subfolder (e.g. |
Yes, I agree |
To generate, execute:
|
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The function documentation should be automatically generated from the comments in javascript.
How this could be done with Jenkins: http://blog.cgdecker.com/2011/02/deploying-documentation-to-github-pages.html
And for Travis: https://gist.github.com/vidavidorra/548ffbcdae99d752da02 or https://docs.travis-ci.com/user/deployment/pages/
The text was updated successfully, but these errors were encountered: