{"action":"created","issue":{"url":"https://api.github.com/repos/skulpt/skulpt/issues/480","labels_url":"https://api.github.com/repos/skulpt/skulpt/issues/480/labels{/name}","comments_url":"https://api.github.com/repos/skulpt/skulpt/issues/480/comments","events_url":"https://api.github.com/repos/skulpt/skulpt/issues/480/events","html_url":"https://github.com/skulpt/skulpt/pull/480","id":85931326,"number":480,"title":"Added jsdoc output","user":{"login":"eah13","id":1702745,"avatar_url":"https://avatars.githubusercontent.com/u/1702745?v=3","gravatar_id":"","url":"https://api.github.com/users/eah13","html_url":"https://github.com/eah13","followers_url":"https://api.github.com/users/eah13/followers","following_url":"https://api.github.com/users/eah13/following{/other_user}","gists_url":"https://api.github.com/users/eah13/gists{/gist_id}","starred_url":"https://api.github.com/users/eah13/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eah13/subscriptions","organizations_url":"https://api.github.com/users/eah13/orgs","repos_url":"https://api.github.com/users/eah13/repos","events_url":"https://api.github.com/users/eah13/events{/privacy}","received_events_url":"https://api.github.com/users/eah13/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":6,"created_at":"2015-06-07T19:24:08Z","updated_at":"2015-06-09T15:09:17Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/skulpt/skulpt/pulls/480","html_url":"https://github.com/skulpt/skulpt/pull/480","diff_url":"https://github.com/skulpt/skulpt/pull/480.diff","patch_url":"https://github.com/skulpt/skulpt/pull/480.patch"},"body":"~~**Update: waiting on #479 to get merged before this will be ready for review.**~~ Ready for Review.\r\n\r\nThis PR puts some jsdoc-generated docs in a `docs` folder.  The `docs` folder is automatically rendered by Jekyll in a /docs/ subdirectory of the site.  See it deployed [here](http://elliotthauser.com/skulpt/docs/)\r\n\r\nThe following has also been added to the `gh-pages` readme:\r\n\r\nThe `docs` folder is generated by jsdoc.  Instead of editing it, each time one of the underlying js files or the HACKING.rst file is changed:                           \r\n                                                                                                                                                                        \r\n1. `git checkout master` if you're not already there                                                                                                                    \r\n2. `npm install -g jsdoc` if you haven't already                                                                                                                        \r\n3. `./skulpt.py doc` to generate the docs in `doc/ProgMan`                                                                                                              \r\n                                                                                                                                                                        \r\nThe generated HTML is now in a folder called `doc/ProgMan` that's in your git working tree                                                                                                                     \r\n                                                                                                                                                                        \r\n4. `git checkout gh-pages` then `git checkout -b new-branch-name`.  Or checkout your pre-existing branch made from `gh-pages`                                           \r\n6. `rsync -r doc/ProgMan docs` then `rm -rf doc`                                                                                                                        \r\n7. `git diff .` to see the changes, `git add .` to add them, `git commit -m \"Commit message here\"`                                                                      \r\n                                                                                                         \r\n\r\n:boom: Instant docs."},"comment":{"url":"https://api.github.com/repos/skulpt/skulpt/issues/comments/110395675","html_url":"https://github.com/skulpt/skulpt/pull/480#issuecomment-110395675","issue_url":"https://api.github.com/repos/skulpt/skulpt/issues/480","id":110395675,"user":{"login":"eah13","id":1702745,"avatar_url":"https://avatars.githubusercontent.com/u/1702745?v=3","gravatar_id":"","url":"https://api.github.com/users/eah13","html_url":"https://github.com/eah13","followers_url":"https://api.github.com/users/eah13/followers","following_url":"https://api.github.com/users/eah13/following{/other_user}","gists_url":"https://api.github.com/users/eah13/gists{/gist_id}","starred_url":"https://api.github.com/users/eah13/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eah13/subscriptions","organizations_url":"https://api.github.com/users/eah13/orgs","repos_url":"https://api.github.com/users/eah13/repos","events_url":"https://api.github.com/users/eah13/events{/privacy}","received_events_url":"https://api.github.com/users/eah13/received_events","type":"User","site_admin":false},"created_at":"2015-06-09T15:09:17Z","updated_at":"2015-06-09T15:09:17Z","body":"Killer.  Done now and the new changes are deployed for easy review http://elliotthauser.com/skulpt/docs/"}}