{"action":"closed","number":314,"pull_request":{"url":"https://api.github.com/repos/hyde/hyde/pulls/314","id":61026366,"html_url":"https://github.com/hyde/hyde/pull/314","diff_url":"https://github.com/hyde/hyde/pull/314.diff","patch_url":"https://github.com/hyde/hyde/pull/314.patch","issue_url":"https://api.github.com/repos/hyde/hyde/issues/314","number":314,"state":"closed","locked":false,"title":"[WIP] Add Sphinx docs","user":{"login":"jonafato","id":392720,"avatar_url":"https://avatars.githubusercontent.com/u/392720?v=3","gravatar_id":"","url":"https://api.github.com/users/jonafato","html_url":"https://github.com/jonafato","followers_url":"https://api.github.com/users/jonafato/followers","following_url":"https://api.github.com/users/jonafato/following{/other_user}","gists_url":"https://api.github.com/users/jonafato/gists{/gist_id}","starred_url":"https://api.github.com/users/jonafato/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jonafato/subscriptions","organizations_url":"https://api.github.com/users/jonafato/orgs","repos_url":"https://api.github.com/users/jonafato/repos","events_url":"https://api.github.com/users/jonafato/events{/privacy}","received_events_url":"https://api.github.com/users/jonafato/received_events","type":"User","site_admin":false},"body":"This is the starting point of documenting Hyde using Sphinx. This\r\nprovides several benefits:\r\n\r\n1. Code and documentation live together, so it's easier to track and\r\nenforce that there exists documentation for new or changing code.\r\n\r\n2. This lets us get Hyde on Read The Docs.\r\n\r\n3. We can use things like `autoclass` where appropriate to pull\r\ndocumentation directly from source code without reinventing the wheel.\r\n\r\nI've tried to replicate what currently exists on hyde.github.io. The\r\nfirst pass of this effort is concerned with parity, and we can continue\r\nto improve from there on. Steps:\r\n\r\n1. Convert all existing documentation on hyde.github.io to Sphinx. This\r\nis covered by this commit and should be considered \"in review\".\r\n\r\n2. Open issues for core parts of Hyde that are missing documentation.\r\n\r\n3. Close these issues individually. This is a great opportunity for\r\ncommunity members wishing to get involved to contribute.\r\n\r\n4. Require significant changes in code to be accompanied by updated /\r\nnew documentation the same way we would require tests.\r\n\r\nWhile these steps are in progress, the following should also be done:\r\n\r\n1. Deprecate the docs at hyde.github.io, linking users to Read The Docs.\r\n\r\n2. Replace the content currently hosted at hyde.github.io with a new\r\nbrochure site showing off some of Hyde's uses and linking to other\r\ninteresting content (e.g. a list of themes, links to sites powered by\r\nHyde, etc.).\r\n\r\nReferences #188, #209, and quite a few other issues.\r\n\r\n@lakshmivyas, @llonchj: please review. This is a starting point for\r\nSphinx docs, and the PR is labelled as a work in progress, but I have no\r\nspecific threshold for it being \"done\". Once we're all satisfied with\r\nthe first pass, I'll set up RTD, and we can start filing issues for\r\nspecific areas lacking docs.","created_at":"2016-02-29T04:22:39Z","updated_at":"2016-03-10T01:59:32Z","closed_at":"2016-03-10T01:59:32Z","merged_at":"2016-03-10T01:59:32Z","merge_commit_sha":"09d16b71c54f9e1f89121edd294152aec45a2b03","assignee":null,"milestone":{"url":"https://api.github.com/repos/hyde/hyde/milestones/5","html_url":"https://github.com/hyde/hyde/milestones/Version%201.0.0","labels_url":"https://api.github.com/repos/hyde/hyde/milestones/5/labels","id":1130436,"number":5,"title":"Version 1.0.0","description":"","creator":{"login":"llonchj","id":355646,"avatar_url":"https://avatars.githubusercontent.com/u/355646?v=3","gravatar_id":"","url":"https://api.github.com/users/llonchj","html_url":"https://github.com/llonchj","followers_url":"https://api.github.com/users/llonchj/followers","following_url":"https://api.github.com/users/llonchj/following{/other_user}","gists_url":"https://api.github.com/users/llonchj/gists{/gist_id}","starred_url":"https://api.github.com/users/llonchj/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/llonchj/subscriptions","organizations_url":"https://api.github.com/users/llonchj/orgs","repos_url":"https://api.github.com/users/llonchj/repos","events_url":"https://api.github.com/users/llonchj/events{/privacy}","received_events_url":"https://api.github.com/users/llonchj/received_events","type":"User","site_admin":false},"open_issues":4,"closed_issues":1,"state":"open","created_at":"2015-05-25T09:21:06Z","updated_at":"2016-03-10T01:59:32Z","due_on":null,"closed_at":null},"commits_url":"https://api.github.com/repos/hyde/hyde/pulls/314/commits","review_comments_url":"https://api.github.com/repos/hyde/hyde/pulls/314/comments","review_comment_url":"https://api.github.com/repos/hyde/hyde/pulls/comments{/number}","comments_url":"https://api.github.com/repos/hyde/hyde/issues/314/comments","statuses_url":"https://api.github.com/repos/hyde/hyde/statuses/b5733d14f3110221b3a69c9ce55b8e59bf057f46","head":{"label":"hyde:sphinx-docs","ref":"sphinx-docs","sha":"b5733d14f3110221b3a69c9ce55b8e59bf057f46","user":{"login":"hyde","id":374679,"avatar_url":"https://avatars.githubusercontent.com/u/374679?v=3","gravatar_id":"","url":"https://api.github.com/users/hyde","html_url":"https://github.com/hyde","followers_url":"https://api.github.com/users/hyde/followers","following_url":"https://api.github.com/users/hyde/following{/other_user}","gists_url":"https://api.github.com/users/hyde/gists{/gist_id}","starred_url":"https://api.github.com/users/hyde/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hyde/subscriptions","organizations_url":"https://api.github.com/users/hyde/orgs","repos_url":"https://api.github.com/users/hyde/repos","events_url":"https://api.github.com/users/hyde/events{/privacy}","received_events_url":"https://api.github.com/users/hyde/received_events","type":"Organization","site_admin":false},"repo":{"id":1229101,"name":"hyde","full_name":"hyde/hyde","owner":{"login":"hyde","id":374679,"avatar_url":"https://avatars.githubusercontent.com/u/374679?v=3","gravatar_id":"","url":"https://api.github.com/users/hyde","html_url":"https://github.com/hyde","followers_url":"https://api.github.com/users/hyde/followers","following_url":"https://api.github.com/users/hyde/following{/other_user}","gists_url":"https://api.github.com/users/hyde/gists{/gist_id}","starred_url":"https://api.github.com/users/hyde/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hyde/subscriptions","organizations_url":"https://api.github.com/users/hyde/orgs","repos_url":"https://api.github.com/users/hyde/repos","events_url":"https://api.github.com/users/hyde/events{/privacy}","received_events_url":"https://api.github.com/users/hyde/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/hyde/hyde","description":"A Python Static Website Generator","fork":false,"url":"https://api.github.com/repos/hyde/hyde","forks_url":"https://api.github.com/repos/hyde/hyde/forks","keys_url":"https://api.github.com/repos/hyde/hyde/keys{/key_id}","collaborators_url":"https://api.github.com/repos/hyde/hyde/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/hyde/hyde/teams","hooks_url":"https://api.github.com/repos/hyde/hyde/hooks","issue_events_url":"https://api.github.com/repos/hyde/hyde/issues/events{/number}","events_url":"https://api.github.com/repos/hyde/hyde/events","assignees_url":"https://api.github.com/repos/hyde/hyde/assignees{/user}","branches_url":"https://api.github.com/repos/hyde/hyde/branches{/branch}","tags_url":"https://api.github.com/repos/hyde/hyde/tags","blobs_url":"https://api.github.com/repos/hyde/hyde/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/hyde/hyde/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/hyde/hyde/git/refs{/sha}","trees_url":"https://api.github.com/repos/hyde/hyde/git/trees{/sha}","statuses_url":"https://api.github.com/repos/hyde/hyde/statuses/{sha}","languages_url":"https://api.github.com/repos/hyde/hyde/languages","stargazers_url":"https://api.github.com/repos/hyde/hyde/stargazers","contributors_url":"https://api.github.com/repos/hyde/hyde/contributors","subscribers_url":"https://api.github.com/repos/hyde/hyde/subscribers","subscription_url":"https://api.github.com/repos/hyde/hyde/subscription","commits_url":"https://api.github.com/repos/hyde/hyde/commits{/sha}","git_commits_url":"https://api.github.com/repos/hyde/hyde/git/commits{/sha}","comments_url":"https://api.github.com/repos/hyde/hyde/comments{/number}","issue_comment_url":"https://api.github.com/repos/hyde/hyde/issues/comments{/number}","contents_url":"https://api.github.com/repos/hyde/hyde/contents/{+path}","compare_url":"https://api.github.com/repos/hyde/hyde/compare/{base}...{head}","merges_url":"https://api.github.com/repos/hyde/hyde/merges","archive_url":"https://api.github.com/repos/hyde/hyde/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/hyde/hyde/downloads","issues_url":"https://api.github.com/repos/hyde/hyde/issues{/number}","pulls_url":"https://api.github.com/repos/hyde/hyde/pulls{/number}","milestones_url":"https://api.github.com/repos/hyde/hyde/milestones{/number}","notifications_url":"https://api.github.com/repos/hyde/hyde/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/hyde/hyde/labels{/name}","releases_url":"https://api.github.com/repos/hyde/hyde/releases{/id}","deployments_url":"https://api.github.com/repos/hyde/hyde/deployments","created_at":"2011-01-07T09:52:20Z","updated_at":"2016-03-08T22:31:00Z","pushed_at":"2016-03-10T01:59:32Z","git_url":"git://github.com/hyde/hyde.git","ssh_url":"git@github.com:hyde/hyde.git","clone_url":"https://github.com/hyde/hyde.git","svn_url":"https://github.com/hyde/hyde","homepage":"http://hyde.github.io","size":3187,"stargazers_count":1269,"watchers_count":1269,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":222,"mirror_url":null,"open_issues_count":60,"forks":222,"open_issues":60,"watchers":1269,"default_branch":"master"}},"base":{"label":"hyde:master","ref":"master","sha":"4f9c82f974d0cf4e3aa9caa79bbb262a85ea5063","user":{"login":"hyde","id":374679,"avatar_url":"https://avatars.githubusercontent.com/u/374679?v=3","gravatar_id":"","url":"https://api.github.com/users/hyde","html_url":"https://github.com/hyde","followers_url":"https://api.github.com/users/hyde/followers","following_url":"https://api.github.com/users/hyde/following{/other_user}","gists_url":"https://api.github.com/users/hyde/gists{/gist_id}","starred_url":"https://api.github.com/users/hyde/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hyde/subscriptions","organizations_url":"https://api.github.com/users/hyde/orgs","repos_url":"https://api.github.com/users/hyde/repos","events_url":"https://api.github.com/users/hyde/events{/privacy}","received_events_url":"https://api.github.com/users/hyde/received_events","type":"Organization","site_admin":false},"repo":{"id":1229101,"name":"hyde","full_name":"hyde/hyde","owner":{"login":"hyde","id":374679,"avatar_url":"https://avatars.githubusercontent.com/u/374679?v=3","gravatar_id":"","url":"https://api.github.com/users/hyde","html_url":"https://github.com/hyde","followers_url":"https://api.github.com/users/hyde/followers","following_url":"https://api.github.com/users/hyde/following{/other_user}","gists_url":"https://api.github.com/users/hyde/gists{/gist_id}","starred_url":"https://api.github.com/users/hyde/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hyde/subscriptions","organizations_url":"https://api.github.com/users/hyde/orgs","repos_url":"https://api.github.com/users/hyde/repos","events_url":"https://api.github.com/users/hyde/events{/privacy}","received_events_url":"https://api.github.com/users/hyde/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/hyde/hyde","description":"A Python Static Website Generator","fork":false,"url":"https://api.github.com/repos/hyde/hyde","forks_url":"https://api.github.com/repos/hyde/hyde/forks","keys_url":"https://api.github.com/repos/hyde/hyde/keys{/key_id}","collaborators_url":"https://api.github.com/repos/hyde/hyde/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/hyde/hyde/teams","hooks_url":"https://api.github.com/repos/hyde/hyde/hooks","issue_events_url":"https://api.github.com/repos/hyde/hyde/issues/events{/number}","events_url":"https://api.github.com/repos/hyde/hyde/events","assignees_url":"https://api.github.com/repos/hyde/hyde/assignees{/user}","branches_url":"https://api.github.com/repos/hyde/hyde/branches{/branch}","tags_url":"https://api.github.com/repos/hyde/hyde/tags","blobs_url":"https://api.github.com/repos/hyde/hyde/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/hyde/hyde/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/hyde/hyde/git/refs{/sha}","trees_url":"https://api.github.com/repos/hyde/hyde/git/trees{/sha}","statuses_url":"https://api.github.com/repos/hyde/hyde/statuses/{sha}","languages_url":"https://api.github.com/repos/hyde/hyde/languages","stargazers_url":"https://api.github.com/repos/hyde/hyde/stargazers","contributors_url":"https://api.github.com/repos/hyde/hyde/contributors","subscribers_url":"https://api.github.com/repos/hyde/hyde/subscribers","subscription_url":"https://api.github.com/repos/hyde/hyde/subscription","commits_url":"https://api.github.com/repos/hyde/hyde/commits{/sha}","git_commits_url":"https://api.github.com/repos/hyde/hyde/git/commits{/sha}","comments_url":"https://api.github.com/repos/hyde/hyde/comments{/number}","issue_comment_url":"https://api.github.com/repos/hyde/hyde/issues/comments{/number}","contents_url":"https://api.github.com/repos/hyde/hyde/contents/{+path}","compare_url":"https://api.github.com/repos/hyde/hyde/compare/{base}...{head}","merges_url":"https://api.github.com/repos/hyde/hyde/merges","archive_url":"https://api.github.com/repos/hyde/hyde/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/hyde/hyde/downloads","issues_url":"https://api.github.com/repos/hyde/hyde/issues{/number}","pulls_url":"https://api.github.com/repos/hyde/hyde/pulls{/number}","milestones_url":"https://api.github.com/repos/hyde/hyde/milestones{/number}","notifications_url":"https://api.github.com/repos/hyde/hyde/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/hyde/hyde/labels{/name}","releases_url":"https://api.github.com/repos/hyde/hyde/releases{/id}","deployments_url":"https://api.github.com/repos/hyde/hyde/deployments","created_at":"2011-01-07T09:52:20Z","updated_at":"2016-03-08T22:31:00Z","pushed_at":"2016-03-10T01:59:32Z","git_url":"git://github.com/hyde/hyde.git","ssh_url":"git@github.com:hyde/hyde.git","clone_url":"https://github.com/hyde/hyde.git","svn_url":"https://github.com/hyde/hyde","homepage":"http://hyde.github.io","size":3187,"stargazers_count":1269,"watchers_count":1269,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":222,"mirror_url":null,"open_issues_count":60,"forks":222,"open_issues":60,"watchers":1269,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/hyde/hyde/pulls/314"},"html":{"href":"https://github.com/hyde/hyde/pull/314"},"issue":{"href":"https://api.github.com/repos/hyde/hyde/issues/314"},"comments":{"href":"https://api.github.com/repos/hyde/hyde/issues/314/comments"},"review_comments":{"href":"https://api.github.com/repos/hyde/hyde/pulls/314/comments"},"review_comment":{"href":"https://api.github.com/repos/hyde/hyde/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/hyde/hyde/pulls/314/commits"},"statuses":{"href":"https://api.github.com/repos/hyde/hyde/statuses/b5733d14f3110221b3a69c9ce55b8e59bf057f46"}},"merged":true,"mergeable":null,"mergeable_state":"unknown","merged_by":{"login":"lakshmivyas","id":45002,"avatar_url":"https://avatars.githubusercontent.com/u/45002?v=3","gravatar_id":"","url":"https://api.github.com/users/lakshmivyas","html_url":"https://github.com/lakshmivyas","followers_url":"https://api.github.com/users/lakshmivyas/followers","following_url":"https://api.github.com/users/lakshmivyas/following{/other_user}","gists_url":"https://api.github.com/users/lakshmivyas/gists{/gist_id}","starred_url":"https://api.github.com/users/lakshmivyas/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lakshmivyas/subscriptions","organizations_url":"https://api.github.com/users/lakshmivyas/orgs","repos_url":"https://api.github.com/users/lakshmivyas/repos","events_url":"https://api.github.com/users/lakshmivyas/events{/privacy}","received_events_url":"https://api.github.com/users/lakshmivyas/received_events","type":"User","site_admin":false},"comments":4,"review_comments":0,"commits":3,"additions":1240,"deletions":31,"changed_files":17}}