{"action":"created","issue":{"url":"https://api.github.com/repos/searchivarius/nmslib/issues/226","repository_url":"https://api.github.com/repos/searchivarius/nmslib","labels_url":"https://api.github.com/repos/searchivarius/nmslib/issues/226/labels{/name}","comments_url":"https://api.github.com/repos/searchivarius/nmslib/issues/226/comments","events_url":"https://api.github.com/repos/searchivarius/nmslib/issues/226/events","html_url":"https://github.com/searchivarius/nmslib/pull/226","id":248594085,"number":226,"title":"Add basic python documentation","user":{"login":"benfred","id":69536,"avatar_url":"https://avatars2.githubusercontent.com/u/69536?v=4","gravatar_id":"","url":"https://api.github.com/users/benfred","html_url":"https://github.com/benfred","followers_url":"https://api.github.com/users/benfred/followers","following_url":"https://api.github.com/users/benfred/following{/other_user}","gists_url":"https://api.github.com/users/benfred/gists{/gist_id}","starred_url":"https://api.github.com/users/benfred/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/benfred/subscriptions","organizations_url":"https://api.github.com/users/benfred/orgs","repos_url":"https://api.github.com/users/benfred/repos","events_url":"https://api.github.com/users/benfred/events{/privacy}","received_events_url":"https://api.github.com/users/benfred/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2017-08-08T03:57:19Z","updated_at":"2017-08-09T19:55:40Z","closed_at":"2017-08-09T18:21:57Z","pull_request":{"url":"https://api.github.com/repos/searchivarius/nmslib/pulls/226","html_url":"https://github.com/searchivarius/nmslib/pull/226","diff_url":"https://github.com/searchivarius/nmslib/pull/226.diff","patch_url":"https://github.com/searchivarius/nmslib/pull/226.patch"},"body":"Using sphinx and autodoc, expose the built in docstrings as html pages.\r\n\r\nThe generated documenation can be viewed here:\r\nhttps://benfred.github.io/nmslib/index.html\r\n\r\nThis documentation can be generated by going 'make html' in the python_bindings/doc folder \r\n(requires ```pip install sphinx sphinx_rtd_theme``` to run first, and the nmslib python bindings need to be\r\ninstalled for the default python as well)."},"comment":{"url":"https://api.github.com/repos/searchivarius/nmslib/issues/comments/321364022","html_url":"https://github.com/searchivarius/nmslib/pull/226#issuecomment-321364022","issue_url":"https://api.github.com/repos/searchivarius/nmslib/issues/226","id":321364022,"user":{"login":"benfred","id":69536,"avatar_url":"https://avatars2.githubusercontent.com/u/69536?v=4","gravatar_id":"","url":"https://api.github.com/users/benfred","html_url":"https://github.com/benfred","followers_url":"https://api.github.com/users/benfred/followers","following_url":"https://api.github.com/users/benfred/following{/other_user}","gists_url":"https://api.github.com/users/benfred/gists{/gist_id}","starred_url":"https://api.github.com/users/benfred/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/benfred/subscriptions","organizations_url":"https://api.github.com/users/benfred/orgs","repos_url":"https://api.github.com/users/benfred/repos","events_url":"https://api.github.com/users/benfred/events{/privacy}","received_events_url":"https://api.github.com/users/benfred/received_events","type":"User","site_admin":false},"created_at":"2017-08-09T19:55:39Z","updated_at":"2017-08-09T19:55:39Z","body":"If you create a 'gh-pages' branch in github for this repo - I can submit a PR against that branch with the generated html pages (that will show up here http://searchivarius.github.io/nmslib/). Longer term we can set it up so that the travis build automatically pushes the generated HTML documentation to this branch to keep it in sync.\r\n\r\nI also want to flesh out the documentation a little bit here - and I see some formatting errors in the docstrings that I also want to clean up. \r\n"}}
{"actor":{"display_login":"benfred"}}