{"action":"created","issue":{"url":"https://api.github.com/repos/nilmtk/nilmtk/issues/368","labels_url":"https://api.github.com/repos/nilmtk/nilmtk/issues/368/labels{/name}","comments_url":"https://api.github.com/repos/nilmtk/nilmtk/issues/368/comments","events_url":"https://api.github.com/repos/nilmtk/nilmtk/issues/368/events","html_url":"https://github.com/nilmtk/nilmtk/issues/368","id":64601656,"number":368,"title":"Move docs from Sphinx to IPython notebooks","user":{"login":"nipunreddevil","id":60985,"avatar_url":"https://avatars.githubusercontent.com/u/60985?v=3","gravatar_id":"","url":"https://api.github.com/users/nipunreddevil","html_url":"https://github.com/nipunreddevil","followers_url":"https://api.github.com/users/nipunreddevil/followers","following_url":"https://api.github.com/users/nipunreddevil/following{/other_user}","gists_url":"https://api.github.com/users/nipunreddevil/gists{/gist_id}","starred_url":"https://api.github.com/users/nipunreddevil/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nipunreddevil/subscriptions","organizations_url":"https://api.github.com/users/nipunreddevil/orgs","repos_url":"https://api.github.com/users/nipunreddevil/repos","events_url":"https://api.github.com/users/nipunreddevil/events{/privacy}","received_events_url":"https://api.github.com/users/nipunreddevil/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/nilmtk/nilmtk/labels/documentation","name":"documentation","color":"006b75"},{"url":"https://api.github.com/repos/nilmtk/nilmtk/labels/Good%20as%20first%20PR","name":"Good as first PR","color":"bfd4f2"}],"state":"open","locked":false,"assignee":null,"milestone":{"url":"https://api.github.com/repos/nilmtk/nilmtk/milestones/5","html_url":"https://github.com/nilmtk/nilmtk/milestones/v0.3","labels_url":"https://api.github.com/repos/nilmtk/nilmtk/milestones/5/labels","id":878008,"number":5,"title":"v0.3","description":"","creator":{"login":"JackKelly","id":460756,"avatar_url":"https://avatars.githubusercontent.com/u/460756?v=3","gravatar_id":"","url":"https://api.github.com/users/JackKelly","html_url":"https://github.com/JackKelly","followers_url":"https://api.github.com/users/JackKelly/followers","following_url":"https://api.github.com/users/JackKelly/following{/other_user}","gists_url":"https://api.github.com/users/JackKelly/gists{/gist_id}","starred_url":"https://api.github.com/users/JackKelly/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/JackKelly/subscriptions","organizations_url":"https://api.github.com/users/JackKelly/orgs","repos_url":"https://api.github.com/users/JackKelly/repos","events_url":"https://api.github.com/users/JackKelly/events{/privacy}","received_events_url":"https://api.github.com/users/JackKelly/received_events","type":"User","site_admin":false},"open_issues":27,"closed_issues":41,"state":"open","created_at":"2014-11-24T09:38:42Z","updated_at":"2015-06-09T06:00:47Z","due_on":null,"closed_at":null},"comments":20,"created_at":"2015-03-26T18:29:31Z","updated_at":"2015-06-09T10:05:55Z","closed_at":null,"body":"We feel that shifting all documentation to IPython notebooks would make:\r\n\r\n1. Easier for users to download notebooks and run on their machines\r\n2. Allow us to maintain and keep the documentation up to date with ease\r\n3. Make it easier for users to contribute documentation. Yes, they don't have to build anything\r\n\r\nThis is a relatively straight forward task. The idea is to copy the relative bits from the documentation [up here](http://nilmtk.github.io/nilmtk/master/index.html) to the notebooks directory. We can then use nbviewer to render the IPython notebooks for us.\r\n\r\nThis task should be a good learning experience for anyone who wants to use nilmtk.\r\n"},"comment":{"url":"https://api.github.com/repos/nilmtk/nilmtk/issues/comments/110300167","html_url":"https://github.com/nilmtk/nilmtk/issues/368#issuecomment-110300167","issue_url":"https://api.github.com/repos/nilmtk/nilmtk/issues/368","id":110300167,"user":{"login":"nipunreddevil","id":60985,"avatar_url":"https://avatars.githubusercontent.com/u/60985?v=3","gravatar_id":"","url":"https://api.github.com/users/nipunreddevil","html_url":"https://github.com/nipunreddevil","followers_url":"https://api.github.com/users/nipunreddevil/followers","following_url":"https://api.github.com/users/nipunreddevil/following{/other_user}","gists_url":"https://api.github.com/users/nipunreddevil/gists{/gist_id}","starred_url":"https://api.github.com/users/nipunreddevil/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nipunreddevil/subscriptions","organizations_url":"https://api.github.com/users/nipunreddevil/orgs","repos_url":"https://api.github.com/users/nipunreddevil/repos","events_url":"https://api.github.com/users/nipunreddevil/events{/privacy}","received_events_url":"https://api.github.com/users/nipunreddevil/received_events","type":"User","site_admin":false},"created_at":"2015-06-09T10:05:55Z","updated_at":"2015-06-09T10:05:55Z","body":"A tiny issue is that we can't add a menu system to IPython notebooks, or can we? Like, we currently have for Sphinx, where all the hyperlinks to previous page, page a level up, etc. are mentioned.\r\n\r\nI think it is not really that important."}}