{"action":"closed","number":801,"pull_request":{"created_at":"2011-11-26T23:13:03Z","review_comments":0,"state":"closed","patch_url":"https://github.com/mrdoob/three.js/pull/801.patch","changed_files":10,"_links":{"review_comments":{"href":"https://api.github.com/repos/mrdoob/three.js/pulls/801/comments"},"comments":{"href":"https://api.github.com/repos/mrdoob/three.js/issues/801/comments"},"html":{"href":"https://github.com/mrdoob/three.js/pull/801"},"self":{"href":"https://api.github.com/repos/mrdoob/three.js/pulls/801"}},"updated_at":"2011-11-28T00:24:24Z","issue_url":"https://github.com/mrdoob/three.js/issues/801","user":{"gravatar_id":"dd56da509c21eebb967777a9dbcce437","id":154510,"url":"https://api.github.com/users/jterrace","login":"jterrace","avatar_url":"https://secure.gravatar.com/avatar/dd56da509c21eebb967777a9dbcce437?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png"},"comments":3,"deletions":0,"body":"This creates a root directory called doc. It has a Makefile that does the following:\r\n1. Downloads [jsdoc-toolkit](http://code.google.com/p/jsdoc-toolkit/)\r\n2. Clones [jsdoc-for-sphinx](https://github.com/stdbrouw/jsdoc-for-sphinx)\r\n3. Uses jsdoc-toolkit and the sphinx template to output sphinx files for three.js\r\n4. Runs a sphinx build to produce HTML output\r\n\r\nThis adds documentation directly into the JS source files. Is this acceptable? I think it's the easiest way to maintain documentation since it's collocated with the code itself.\r\n\r\nThis is an example of the output that gets produced:\r\nhttp://www.cs.princeton.edu/~jterrace/temp/threejs/generated/core/THREE.Color.html\r\nI have only documented the THREE.Color class so far, so this is just an example page. This is what the documented source code looks like:\r\nhttps://github.com/jterrace/three.js/blob/2960863897af11705075377ffb7fefef28266f68/src/core/Color.js\r\n\r\nTo be clear: **this is not ready to merge**. I just wanted to open this up to get comments since I don't want to spend the time documenting the rest of the project if this is not the route the maintainers want to take. I think this would be a great way to generate some nice documentation, and sphinx is also great for writing tutorials and examples.","merged":false,"commits":4,"mergeable":true,"id":530944,"merged_by":null,"base":{"user":{"gravatar_id":"a00211a1e1aa4fe920302e7b76da0d91","id":97088,"url":"https://api.github.com/users/mrdoob","login":"mrdoob","avatar_url":"https://secure.gravatar.com/avatar/a00211a1e1aa4fe920302e7b76da0d91?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png"},"repo":{"created_at":"2010-03-23T18:58:01Z","pushed_at":"2011-11-25T02:13:45Z","private":false,"updated_at":"2011-11-27T23:07:59Z","clone_url":"https://github.com/mrdoob/three.js.git","svn_url":"https://svn.github.com/mrdoob/three.js","name":"three.js","master_branch":"master","watchers":4237,"language":"JavaScript","forks":414,"owner":{"gravatar_id":"a00211a1e1aa4fe920302e7b76da0d91","id":97088,"url":"https://api.github.com/users/mrdoob","login":"mrdoob","avatar_url":"https://secure.gravatar.com/avatar/a00211a1e1aa4fe920302e7b76da0d91?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png"},"id":576201,"homepage":"http://mrdoob.github.com/three.js/","git_url":"git://github.com/mrdoob/three.js.git","description":"JavaScript 3D Engine","html_url":"https://github.com/mrdoob/three.js","size":1624,"ssh_url":"git@github.com:mrdoob/three.js.git","fork":false,"url":"https://api.github.com/repos/mrdoob/three.js","open_issues":87},"sha":"befc98a01e44efe7380bf27e2d290cfa97118348","ref":"dev","label":"mrdoob:dev"},"number":801,"additions":489,"title":"Adds Documentation Generation using jsdoc-toolkit and Sphinx","head":{"user":{"gravatar_id":"dd56da509c21eebb967777a9dbcce437","id":154510,"url":"https://api.github.com/users/jterrace","login":"jterrace","avatar_url":"https://secure.gravatar.com/avatar/dd56da509c21eebb967777a9dbcce437?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png"},"repo":{"created_at":"2011-11-20T02:29:12Z","pushed_at":"2011-11-25T21:44:41Z","private":false,"updated_at":"2011-11-25T21:44:42Z","clone_url":"https://github.com/jterrace/three.js.git","svn_url":"https://svn.github.com/jterrace/three.js","name":"three.js","master_branch":"master","watchers":1,"language":"JavaScript","forks":0,"owner":{"gravatar_id":"dd56da509c21eebb967777a9dbcce437","id":154510,"url":"https://api.github.com/users/jterrace","login":"jterrace","avatar_url":"https://secure.gravatar.com/avatar/dd56da509c21eebb967777a9dbcce437?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png"},"id":2811934,"homepage":"http://mrdoob.github.com/three.js/","git_url":"git://github.com/jterrace/three.js.git","description":"JavaScript 3D Engine","html_url":"https://github.com/jterrace/three.js","size":124,"ssh_url":"git@github.com:jterrace/three.js.git","fork":true,"url":"https://api.github.com/repos/jterrace/three.js","open_issues":0},"sha":"2960863897af11705075377ffb7fefef28266f68","ref":"dev","label":"jterrace:dev"},"closed_at":"2011-11-28T00:24:24Z","html_url":"https://github.com/mrdoob/three.js/pull/801","url":"https://api.github.com/repos/mrdoob/three.js/pulls/801","diff_url":"https://github.com/mrdoob/three.js/pull/801.diff","merged_at":null}}