{"action":"created","issue":{"url":"https://api.github.com/repos/PyAbel/PyAbel/issues/138","repository_url":"https://api.github.com/repos/PyAbel/PyAbel","labels_url":"https://api.github.com/repos/PyAbel/PyAbel/issues/138/labels{/name}","comments_url":"https://api.github.com/repos/PyAbel/PyAbel/issues/138/comments","events_url":"https://api.github.com/repos/PyAbel/PyAbel/issues/138/events","html_url":"https://github.com/PyAbel/PyAbel/pull/138","id":139028224,"number":138,"title":"Changed readme to look good on GitHub (and PyPi)","user":{"login":"DanHickstein","id":1107796,"avatar_url":"https://avatars.githubusercontent.com/u/1107796?v=3","gravatar_id":"","url":"https://api.github.com/users/DanHickstein","html_url":"https://github.com/DanHickstein","followers_url":"https://api.github.com/users/DanHickstein/followers","following_url":"https://api.github.com/users/DanHickstein/following{/other_user}","gists_url":"https://api.github.com/users/DanHickstein/gists{/gist_id}","starred_url":"https://api.github.com/users/DanHickstein/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/DanHickstein/subscriptions","organizations_url":"https://api.github.com/users/DanHickstein/orgs","repos_url":"https://api.github.com/users/DanHickstein/repos","events_url":"https://api.github.com/users/DanHickstein/events{/privacy}","received_events_url":"https://api.github.com/users/DanHickstein/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2016-03-07T16:43:18Z","updated_at":"2016-03-07T21:30:12Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/PyAbel/PyAbel/pulls/138","html_url":"https://github.com/PyAbel/PyAbel/pull/138","diff_url":"https://github.com/PyAbel/PyAbel/pull/138.diff","patch_url":"https://github.com/PyAbel/PyAbel/pull/138.patch"},"body":"In https://github.com/PyAbel/PyAbel/pull/135, I had formatted the links in the readme to look good on readthedocs.org. However, the readme can also be viewed directly on GitHub as well as whenever we make a release on PyPi: https://pypi.python.org/pypi/PyAbel. This limits the type of links that can be included in the readme.\r\n\r\n(well, [there is a way around this](https://groups.google.com/forum/#!topic/sphinx-dev/bItey05hfFw), but it was too complicated for me to figure out)\r\n\r\nFor readthedocs.org (and any Sphinx documentation build), it's good to use links in the format\r\n```rst\r\n :doc:`link text <file>`\r\n```\r\nHowever, this doesn't work with a simple RST interpreter like what is in place on GitHub or PyPi. So, the readme is a special document, and we can only use links in the standard RST format:\r\n```\r\n`link text <http://external.link/blah.html>`_\r\n```\r\nThis makes me less inclined to include huge amounts of information in the readme (the readme should be reasonably short anyway). So, I moved the more detailed information about the transforms to `doc/transform_methods.rst`.\r\n\r\nNow, I think the readme should look fine, both on github and on readthedocs.org. However, it still looks nicer on readthedocs (images are the correct size instead of being huge), so I included a note at the top referring people to the readthedocs.org.\r\n\r\nYou can check out how the readme will be rendered on GitHub over at my fork: \r\nhttps://github.com/DanHickstein/PyAbel/tree/fix-readme\r\n"},"comment":{"url":"https://api.github.com/repos/PyAbel/PyAbel/issues/comments/193461404","html_url":"https://github.com/PyAbel/PyAbel/pull/138#issuecomment-193461404","issue_url":"https://api.github.com/repos/PyAbel/PyAbel/issues/138","id":193461404,"user":{"login":"DanHickstein","id":1107796,"avatar_url":"https://avatars.githubusercontent.com/u/1107796?v=3","gravatar_id":"","url":"https://api.github.com/users/DanHickstein","html_url":"https://github.com/DanHickstein","followers_url":"https://api.github.com/users/DanHickstein/followers","following_url":"https://api.github.com/users/DanHickstein/following{/other_user}","gists_url":"https://api.github.com/users/DanHickstein/gists{/gist_id}","starred_url":"https://api.github.com/users/DanHickstein/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/DanHickstein/subscriptions","organizations_url":"https://api.github.com/users/DanHickstein/orgs","repos_url":"https://api.github.com/users/DanHickstein/repos","events_url":"https://api.github.com/users/DanHickstein/events{/privacy}","received_events_url":"https://api.github.com/users/DanHickstein/received_events","type":"User","site_admin":false},"created_at":"2016-03-07T21:30:12Z","updated_at":"2016-03-07T21:30:12Z","body":"Thanks @stggh!\r\n\r\n1. I tried for a while to figure out how to make a link open in a new window in an `.rst\r\n\r\n2. The readthedocs build failed for some weird reason. I restarted it and it worked fine. There is a little green link in the lower left of the readthedocs page that lets you see more information and you can click on the \"Builds\" tab to make sure that things are working. \r\n\r\nhttps://readthedocs.org/projects/pyabel/builds/"}}