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

Use autogenerated function documentation #9

Closed
plata opened this issue Dec 30, 2016 · 4 comments · Fixed by #553
Closed

Use autogenerated function documentation #9

plata opened this issue Dec 30, 2016 · 4 comments · Fixed by #553

Comments

@plata
Copy link
Collaborator

plata commented Dec 30, 2016

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/

@plata
Copy link
Collaborator Author

plata commented Feb 14, 2018

We could also use sphinx-js and ReadTheDocs. There's a description in the example.

What do you think?

@plata
Copy link
Collaborator Author

plata commented Mar 30, 2018

If we use GitHub pages instead of the wiki for documentation, we should generate the jsdoc to a subfolder (e.g. docs/jsdoc) and then include this as a link or with Jekyll include.

@madoar
Copy link
Collaborator

madoar commented Mar 30, 2018

Yes, I agree

@plata
Copy link
Collaborator Author

plata commented Apr 7, 2018

To generate, execute:

jsdoc -d docs/jsdoc -r .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants