{"action":"created","comment":{"url":"https://api.github.com/repos/sphinx-doc/sphinx/pulls/comments/157779483","pull_request_review_id":84478156,"id":157779483,"diff_hunk":"@@ -1,45 +1,94 @@\n+========\n+ Sphinx\n+========\n+\n .. image:: https://img.shields.io/pypi/v/sphinx.svg\n    :target: https://pypi.python.org/pypi/Sphinx\n+   :alt: Package on PyPi\n+\n .. image:: https://readthedocs.org/projects/sphinx/badge/\n    :target: http://www.sphinx-doc.org/\n    :alt: Documentation Status\n+\n .. image:: https://travis-ci.org/sphinx-doc/sphinx.svg?branch=master\n    :target: https://travis-ci.org/sphinx-doc/sphinx\n+   :alt: Build Status (Travis CI)\n+\n+.. image:: https://img.shields.io/appveyor/ci/sphinxdoc/sphinx.svg\n+   :target: https://ci.appveyor.com/project/sphinxdoc/sphinx\n+   :alt: Build Status (AppVeyor)\n+\n+Sphinx is a tool that makes it easy to create intelligent and beautiful\n+documentation for Python projects (or other documents consisting of multiple\n+reStructuredText sources), written by Georg Brandl.  It was originally created\n+for the new Python documentation, and has excellent facilities for Python\n+project documentation, but C/C++ is supported as well, and more languages are\n+planned.\n+\n+Sphinx uses reStructuredText as its markup language, and many of its strengths\n+come from the power and straightforwardness of reStructuredText and its parsing\n+and translating suite, the Docutils.\n+\n+Among its features are the following:\n+\n+* Output formats: HTML (including derivative formats such as HTML Help, Epub\n+  and Qt Help), plain text, manual pages and LaTeX or direct PDF output\n+  using rst2pdf\n+* Extensive cross-references: semantic markup and automatic links\n+  for functions, classes, glossary terms and similar pieces of information\n+* Hierarchical structure: easy definition of a document tree, with automatic\n+  links to siblings, parents and children\n+* Automatic indices: general index as well as a module index\n+* Code handling: automatic highlighting using the Pygments highlighter\n+* Flexible HTML output using the Jinja 2 templating engine\n+* Various extensions are available, e.g. for automatic testing of snippets\n+  and inclusion of appropriately formatted docstrings\n+* Setuptools integration\n+\n+For more information, refer to the `the documentation`__.\n+\n+__ http://www.sphinx-doc.org/\n+\n+Installation\n+============\n \n-=================\n-README for Sphinx\n-=================\n-\n-This is the Sphinx documentation generator, see http://www.sphinx-doc.org/.\n-\n-\n-Installing\n-==========\n-\n-Install from PyPI to use stable version::\n+Sphinx is published on `PyPi`__ and can be installed from there::","path":"README.rst","position":null,"original_position":66,"commit_id":"a6f0ba0fc95db043a08d4379481d69a9cb917453","original_commit_id":"a8a25613f34632a0df4c701d17ed5e248483771f","user":{"login":"stephenfin","id":1690835,"avatar_url":"https://avatars2.githubusercontent.com/u/1690835?v=4","gravatar_id":"","url":"https://api.github.com/users/stephenfin","html_url":"https://github.com/stephenfin","followers_url":"https://api.github.com/users/stephenfin/followers","following_url":"https://api.github.com/users/stephenfin/following{/other_user}","gists_url":"https://api.github.com/users/stephenfin/gists{/gist_id}","starred_url":"https://api.github.com/users/stephenfin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stephenfin/subscriptions","organizations_url":"https://api.github.com/users/stephenfin/orgs","repos_url":"https://api.github.com/users/stephenfin/repos","events_url":"https://api.github.com/users/stephenfin/events{/privacy}","received_events_url":"https://api.github.com/users/stephenfin/received_events","type":"User","site_admin":false},"body":"@tk0miya Oops. Now it's done.","created_at":"2017-12-19T15:07:21Z","updated_at":"2017-12-19T15:07:21Z","html_url":"https://github.com/sphinx-doc/sphinx/pull/4321#discussion_r157779483","pull_request_url":"https://api.github.com/repos/sphinx-doc/sphinx/pulls/4321","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/sphinx-doc/sphinx/pulls/comments/157779483"},"html":{"href":"https://github.com/sphinx-doc/sphinx/pull/4321#discussion_r157779483"},"pull_request":{"href":"https://api.github.com/repos/sphinx-doc/sphinx/pulls/4321"}},"in_reply_to_id":157768709},"pull_request":{"url":"https://api.github.com/repos/sphinx-doc/sphinx/pulls/4321","id":159151725,"html_url":"https://github.com/sphinx-doc/sphinx/pull/4321","diff_url":"https://github.com/sphinx-doc/sphinx/pull/4321.diff","patch_url":"https://github.com/sphinx-doc/sphinx/pull/4321.patch","issue_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/4321","number":4321,"state":"open","locked":false,"title":"Readme improvements","user":{"login":"stephenfin","id":1690835,"avatar_url":"https://avatars2.githubusercontent.com/u/1690835?v=4","gravatar_id":"","url":"https://api.github.com/users/stephenfin","html_url":"https://github.com/stephenfin","followers_url":"https://api.github.com/users/stephenfin/followers","following_url":"https://api.github.com/users/stephenfin/following{/other_user}","gists_url":"https://api.github.com/users/stephenfin/gists{/gist_id}","starred_url":"https://api.github.com/users/stephenfin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stephenfin/subscriptions","organizations_url":"https://api.github.com/users/stephenfin/orgs","repos_url":"https://api.github.com/users/stephenfin/repos","events_url":"https://api.github.com/users/stephenfin/events{/privacy}","received_events_url":"https://api.github.com/users/stephenfin/received_events","type":"User","site_admin":false},"body":"Subject: Improve the README\r\n\r\n### Feature or Bugfix\r\nRefactor\r\n\r\n### Purpose\r\nMove the contents of `long_desc` from `setup.py` into the README, and simply use this README for `long_desc`.\r\n\r\n### Detail\r\n- setup.cfg: Restructure file\r\n\r\n  Place configuration of the package itself first in the file, followed by configuration of other tools.\r\n\r\n- Improve README\r\n\r\n  We're going to be adding additional badges to this but, before we do that, we should improve the README and remove a lot of the duplication that has built up here.\r\n\r\n  The 'long_description' from 'setup.py' is moved into the README as there is serious value in displaying this on GitHub, as much as there is value in including the badges and other content from README.\r\n\r\n- README: Cleanup badges\r\n\r\n  Add AppVeyor badge and include 'alt' attributes for the others.\r\n\r\n","created_at":"2017-12-19T12:13:39Z","updated_at":"2017-12-19T15:07:21Z","closed_at":null,"merged_at":null,"merge_commit_sha":"b64b773b2b0be46fceb9fd36494ff76102c610bd","assignee":null,"assignees":[],"requested_reviewers":[],"milestone":null,"commits_url":"https://api.github.com/repos/sphinx-doc/sphinx/pulls/4321/commits","review_comments_url":"https://api.github.com/repos/sphinx-doc/sphinx/pulls/4321/comments","review_comment_url":"https://api.github.com/repos/sphinx-doc/sphinx/pulls/comments{/number}","comments_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/4321/comments","statuses_url":"https://api.github.com/repos/sphinx-doc/sphinx/statuses/a6f0ba0fc95db043a08d4379481d69a9cb917453","head":{"label":"stephenfin:readme-improvements","ref":"readme-improvements","sha":"a6f0ba0fc95db043a08d4379481d69a9cb917453","user":{"login":"stephenfin","id":1690835,"avatar_url":"https://avatars2.githubusercontent.com/u/1690835?v=4","gravatar_id":"","url":"https://api.github.com/users/stephenfin","html_url":"https://github.com/stephenfin","followers_url":"https://api.github.com/users/stephenfin/followers","following_url":"https://api.github.com/users/stephenfin/following{/other_user}","gists_url":"https://api.github.com/users/stephenfin/gists{/gist_id}","starred_url":"https://api.github.com/users/stephenfin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stephenfin/subscriptions","organizations_url":"https://api.github.com/users/stephenfin/orgs","repos_url":"https://api.github.com/users/stephenfin/repos","events_url":"https://api.github.com/users/stephenfin/events{/privacy}","received_events_url":"https://api.github.com/users/stephenfin/received_events","type":"User","site_admin":false},"repo":{"id":83070347,"name":"sphinx","full_name":"stephenfin/sphinx","owner":{"login":"stephenfin","id":1690835,"avatar_url":"https://avatars2.githubusercontent.com/u/1690835?v=4","gravatar_id":"","url":"https://api.github.com/users/stephenfin","html_url":"https://github.com/stephenfin","followers_url":"https://api.github.com/users/stephenfin/followers","following_url":"https://api.github.com/users/stephenfin/following{/other_user}","gists_url":"https://api.github.com/users/stephenfin/gists{/gist_id}","starred_url":"https://api.github.com/users/stephenfin/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stephenfin/subscriptions","organizations_url":"https://api.github.com/users/stephenfin/orgs","repos_url":"https://api.github.com/users/stephenfin/repos","events_url":"https://api.github.com/users/stephenfin/events{/privacy}","received_events_url":"https://api.github.com/users/stephenfin/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/stephenfin/sphinx","description":"Main repository for the Sphinx documentation builder","fork":true,"url":"https://api.github.com/repos/stephenfin/sphinx","forks_url":"https://api.github.com/repos/stephenfin/sphinx/forks","keys_url":"https://api.github.com/repos/stephenfin/sphinx/keys{/key_id}","collaborators_url":"https://api.github.com/repos/stephenfin/sphinx/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/stephenfin/sphinx/teams","hooks_url":"https://api.github.com/repos/stephenfin/sphinx/hooks","issue_events_url":"https://api.github.com/repos/stephenfin/sphinx/issues/events{/number}","events_url":"https://api.github.com/repos/stephenfin/sphinx/events","assignees_url":"https://api.github.com/repos/stephenfin/sphinx/assignees{/user}","branches_url":"https://api.github.com/repos/stephenfin/sphinx/branches{/branch}","tags_url":"https://api.github.com/repos/stephenfin/sphinx/tags","blobs_url":"https://api.github.com/repos/stephenfin/sphinx/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/stephenfin/sphinx/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/stephenfin/sphinx/git/refs{/sha}","trees_url":"https://api.github.com/repos/stephenfin/sphinx/git/trees{/sha}","statuses_url":"https://api.github.com/repos/stephenfin/sphinx/statuses/{sha}","languages_url":"https://api.github.com/repos/stephenfin/sphinx/languages","stargazers_url":"https://api.github.com/repos/stephenfin/sphinx/stargazers","contributors_url":"https://api.github.com/repos/stephenfin/sphinx/contributors","subscribers_url":"https://api.github.com/repos/stephenfin/sphinx/subscribers","subscription_url":"https://api.github.com/repos/stephenfin/sphinx/subscription","commits_url":"https://api.github.com/repos/stephenfin/sphinx/commits{/sha}","git_commits_url":"https://api.github.com/repos/stephenfin/sphinx/git/commits{/sha}","comments_url":"https://api.github.com/repos/stephenfin/sphinx/comments{/number}","issue_comment_url":"https://api.github.com/repos/stephenfin/sphinx/issues/comments{/number}","contents_url":"https://api.github.com/repos/stephenfin/sphinx/contents/{+path}","compare_url":"https://api.github.com/repos/stephenfin/sphinx/compare/{base}...{head}","merges_url":"https://api.github.com/repos/stephenfin/sphinx/merges","archive_url":"https://api.github.com/repos/stephenfin/sphinx/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/stephenfin/sphinx/downloads","issues_url":"https://api.github.com/repos/stephenfin/sphinx/issues{/number}","pulls_url":"https://api.github.com/repos/stephenfin/sphinx/pulls{/number}","milestones_url":"https://api.github.com/repos/stephenfin/sphinx/milestones{/number}","notifications_url":"https://api.github.com/repos/stephenfin/sphinx/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/stephenfin/sphinx/labels{/name}","releases_url":"https://api.github.com/repos/stephenfin/sphinx/releases{/id}","deployments_url":"https://api.github.com/repos/stephenfin/sphinx/deployments","created_at":"2017-02-24T18:21:46Z","updated_at":"2017-02-24T18:21:49Z","pushed_at":"2017-12-19T15:06:31Z","git_url":"git://github.com/stephenfin/sphinx.git","ssh_url":"git@github.com:stephenfin/sphinx.git","clone_url":"https://github.com/stephenfin/sphinx.git","svn_url":"https://github.com/stephenfin/sphinx","homepage":"http://sphinx-doc.org","size":22946,"stargazers_count":0,"watchers_count":0,"language":"Python","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"other","name":"Other","spdx_id":null,"url":null},"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"sphinx-doc:master","ref":"master","sha":"f98bc4becc2187c0ef1ce29367c8cc732387423e","user":{"login":"sphinx-doc","id":9928167,"avatar_url":"https://avatars2.githubusercontent.com/u/9928167?v=4","gravatar_id":"","url":"https://api.github.com/users/sphinx-doc","html_url":"https://github.com/sphinx-doc","followers_url":"https://api.github.com/users/sphinx-doc/followers","following_url":"https://api.github.com/users/sphinx-doc/following{/other_user}","gists_url":"https://api.github.com/users/sphinx-doc/gists{/gist_id}","starred_url":"https://api.github.com/users/sphinx-doc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sphinx-doc/subscriptions","organizations_url":"https://api.github.com/users/sphinx-doc/orgs","repos_url":"https://api.github.com/users/sphinx-doc/repos","events_url":"https://api.github.com/users/sphinx-doc/events{/privacy}","received_events_url":"https://api.github.com/users/sphinx-doc/received_events","type":"Organization","site_admin":false},"repo":{"id":28710753,"name":"sphinx","full_name":"sphinx-doc/sphinx","owner":{"login":"sphinx-doc","id":9928167,"avatar_url":"https://avatars2.githubusercontent.com/u/9928167?v=4","gravatar_id":"","url":"https://api.github.com/users/sphinx-doc","html_url":"https://github.com/sphinx-doc","followers_url":"https://api.github.com/users/sphinx-doc/followers","following_url":"https://api.github.com/users/sphinx-doc/following{/other_user}","gists_url":"https://api.github.com/users/sphinx-doc/gists{/gist_id}","starred_url":"https://api.github.com/users/sphinx-doc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/sphinx-doc/subscriptions","organizations_url":"https://api.github.com/users/sphinx-doc/orgs","repos_url":"https://api.github.com/users/sphinx-doc/repos","events_url":"https://api.github.com/users/sphinx-doc/events{/privacy}","received_events_url":"https://api.github.com/users/sphinx-doc/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/sphinx-doc/sphinx","description":"Main repository for the Sphinx documentation builder","fork":false,"url":"https://api.github.com/repos/sphinx-doc/sphinx","forks_url":"https://api.github.com/repos/sphinx-doc/sphinx/forks","keys_url":"https://api.github.com/repos/sphinx-doc/sphinx/keys{/key_id}","collaborators_url":"https://api.github.com/repos/sphinx-doc/sphinx/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/sphinx-doc/sphinx/teams","hooks_url":"https://api.github.com/repos/sphinx-doc/sphinx/hooks","issue_events_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/events{/number}","events_url":"https://api.github.com/repos/sphinx-doc/sphinx/events","assignees_url":"https://api.github.com/repos/sphinx-doc/sphinx/assignees{/user}","branches_url":"https://api.github.com/repos/sphinx-doc/sphinx/branches{/branch}","tags_url":"https://api.github.com/repos/sphinx-doc/sphinx/tags","blobs_url":"https://api.github.com/repos/sphinx-doc/sphinx/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/sphinx-doc/sphinx/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/sphinx-doc/sphinx/git/refs{/sha}","trees_url":"https://api.github.com/repos/sphinx-doc/sphinx/git/trees{/sha}","statuses_url":"https://api.github.com/repos/sphinx-doc/sphinx/statuses/{sha}","languages_url":"https://api.github.com/repos/sphinx-doc/sphinx/languages","stargazers_url":"https://api.github.com/repos/sphinx-doc/sphinx/stargazers","contributors_url":"https://api.github.com/repos/sphinx-doc/sphinx/contributors","subscribers_url":"https://api.github.com/repos/sphinx-doc/sphinx/subscribers","subscription_url":"https://api.github.com/repos/sphinx-doc/sphinx/subscription","commits_url":"https://api.github.com/repos/sphinx-doc/sphinx/commits{/sha}","git_commits_url":"https://api.github.com/repos/sphinx-doc/sphinx/git/commits{/sha}","comments_url":"https://api.github.com/repos/sphinx-doc/sphinx/comments{/number}","issue_comment_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/comments{/number}","contents_url":"https://api.github.com/repos/sphinx-doc/sphinx/contents/{+path}","compare_url":"https://api.github.com/repos/sphinx-doc/sphinx/compare/{base}...{head}","merges_url":"https://api.github.com/repos/sphinx-doc/sphinx/merges","archive_url":"https://api.github.com/repos/sphinx-doc/sphinx/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/sphinx-doc/sphinx/downloads","issues_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues{/number}","pulls_url":"https://api.github.com/repos/sphinx-doc/sphinx/pulls{/number}","milestones_url":"https://api.github.com/repos/sphinx-doc/sphinx/milestones{/number}","notifications_url":"https://api.github.com/repos/sphinx-doc/sphinx/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/sphinx-doc/sphinx/labels{/name}","releases_url":"https://api.github.com/repos/sphinx-doc/sphinx/releases{/id}","deployments_url":"https://api.github.com/repos/sphinx-doc/sphinx/deployments","created_at":"2015-01-02T10:53:28Z","updated_at":"2017-12-19T09:05:12Z","pushed_at":"2017-12-19T15:06:33Z","git_url":"git://github.com/sphinx-doc/sphinx.git","ssh_url":"git@github.com:sphinx-doc/sphinx.git","clone_url":"https://github.com/sphinx-doc/sphinx.git","svn_url":"https://github.com/sphinx-doc/sphinx","homepage":"http://sphinx-doc.org","size":25043,"stargazers_count":1513,"watchers_count":1513,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":664,"mirror_url":null,"archived":false,"open_issues_count":729,"license":{"key":"other","name":"Other","spdx_id":null,"url":null},"forks":664,"open_issues":729,"watchers":1513,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/sphinx-doc/sphinx/pulls/4321"},"html":{"href":"https://github.com/sphinx-doc/sphinx/pull/4321"},"issue":{"href":"https://api.github.com/repos/sphinx-doc/sphinx/issues/4321"},"comments":{"href":"https://api.github.com/repos/sphinx-doc/sphinx/issues/4321/comments"},"review_comments":{"href":"https://api.github.com/repos/sphinx-doc/sphinx/pulls/4321/comments"},"review_comment":{"href":"https://api.github.com/repos/sphinx-doc/sphinx/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/sphinx-doc/sphinx/pulls/4321/commits"},"statuses":{"href":"https://api.github.com/repos/sphinx-doc/sphinx/statuses/a6f0ba0fc95db043a08d4379481d69a9cb917453"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"stephenfin"}}