{"action":"created","issue":{"url":"https://api.github.com/repos/fossasia/yaydoc/issues/77","repository_url":"https://api.github.com/repos/fossasia/yaydoc","labels_url":"https://api.github.com/repos/fossasia/yaydoc/issues/77/labels{/name}","comments_url":"https://api.github.com/repos/fossasia/yaydoc/issues/77/comments","events_url":"https://api.github.com/repos/fossasia/yaydoc/issues/77/events","html_url":"https://github.com/fossasia/yaydoc/pull/77","id":233559987,"number":77,"title":"fix relative links with include directive","user":{"login":"pri22296","id":11555869,"avatar_url":"https://avatars0.githubusercontent.com/u/11555869?v=3","gravatar_id":"","url":"https://api.github.com/users/pri22296","html_url":"https://github.com/pri22296","followers_url":"https://api.github.com/users/pri22296/followers","following_url":"https://api.github.com/users/pri22296/following{/other_user}","gists_url":"https://api.github.com/users/pri22296/gists{/gist_id}","starred_url":"https://api.github.com/users/pri22296/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pri22296/subscriptions","organizations_url":"https://api.github.com/users/pri22296/orgs","repos_url":"https://api.github.com/users/pri22296/repos","events_url":"https://api.github.com/users/pri22296/events{/privacy}","received_events_url":"https://api.github.com/users/pri22296/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":3,"created_at":"2017-06-05T11:19:38Z","updated_at":"2017-06-07T07:56:00Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/fossasia/yaydoc/pulls/77","html_url":"https://github.com/fossasia/yaydoc/pull/77","diff_url":"https://github.com/fossasia/yaydoc/pull/77.diff","patch_url":"https://github.com/fossasia/yaydoc/pull/77.patch"},"body":"<!--\r\nThanks for submitting a change to yaydoc!\r\n\r\nTo make it possible for us to get your change reviewed and merged please fill out below information carefully.\r\n\r\n-->\r\n\r\n## Description\r\n<!--- Describe your changes in detail -->\r\n- Used a new way to extend the include directive. It involves monkey patching the FileInput class from\r\ndocutils.io. This approach prevents duplication of code from the docutils package which was being done     earlier.\r\n- Added a method which fixes any relative links when included via include directive. currently only works\r\n when included from an above directory. should be enough for now as the most important motivation for\r\n this change was the ability to include README file from root without breaking relative links.\r\n\r\n## Related Issue\r\n<!--- This project only accepts pull requests related to open issues -->\r\n<!--- If suggesting a new feature or change, please discuss it in an issue first -->\r\n<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->\r\n<!--- Please link to the issue here: -->\r\nFixes #72\r\n\r\n## Motivation and Context\r\n<!--- Why is this change required? What problem does it solve? -->\r\nIf README contains any links which are relative, when included inside any directory, those links would break. This often lead to duplication of content in index.rst and README. to avoid this, the links need to\r\nadjusted according to the path from where they are included.\r\n\r\n## How Has This Been Tested?\r\n<!--- Please describe in detail how you tested your changes. -->\r\n<!--- Include details of your testing environment, and the tests you ran to -->\r\n<!--- see how your change affects other areas of the code, etc. -->\r\nThe link named `chat_api` added under prerequisites in the below documents works both in github readme and build docs. This would not have worked earlier. \r\n\r\nTest Github Repo - https://github.com/pri22296/testYaydoc2\r\nBuild Docs - https://pri22296.github.io/testYaydoc2/\r\n\r\n## Screenshots (if appropriate):\r\n\r\n## Types of changes\r\n<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->\r\n- [ ] Bug fix \r\n- [x] New feature\r\n\r\n## Checklist:\r\n<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->\r\n- [x] I have read the [Contribution & Best practices Guide](https://blog.fossasia.org/open-source-developer-guide-and-best-practices-at-fossasia) and my PR follows them.\r\n- [x] There is a corresponding issue for this pull request.\r\n- [x] Mentioned the Issue number in the pull request commit message `Fixes #<number> commit message`\r\n- [x] There is only one commit per issue.\r\n"},"comment":{"url":"https://api.github.com/repos/fossasia/yaydoc/issues/comments/306718828","html_url":"https://github.com/fossasia/yaydoc/pull/77#issuecomment-306718828","issue_url":"https://api.github.com/repos/fossasia/yaydoc/issues/77","id":306718828,"user":{"login":"pri22296","id":11555869,"avatar_url":"https://avatars0.githubusercontent.com/u/11555869?v=3","gravatar_id":"","url":"https://api.github.com/users/pri22296","html_url":"https://github.com/pri22296","followers_url":"https://api.github.com/users/pri22296/followers","following_url":"https://api.github.com/users/pri22296/following{/other_user}","gists_url":"https://api.github.com/users/pri22296/gists{/gist_id}","starred_url":"https://api.github.com/users/pri22296/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pri22296/subscriptions","organizations_url":"https://api.github.com/users/pri22296/orgs","repos_url":"https://api.github.com/users/pri22296/repos","events_url":"https://api.github.com/users/pri22296/events{/privacy}","received_events_url":"https://api.github.com/users/pri22296/received_events","type":"User","site_admin":false},"created_at":"2017-06-07T07:56:00Z","updated_at":"2017-06-07T07:56:00Z","body":"@sch00lb0y I have fixed all codacy issues except `unable to import` issues. I did disable some existing issues as they were too trivial. pleae give your suggestions about the `unable to import` issues. They seems to happen on all custom packages import."}}
{"actor":{"display_login":"pri22296"}}