{"action":"created","issue":{"url":"https://api.github.com/repos/nilearn/nilearn/issues/592","labels_url":"https://api.github.com/repos/nilearn/nilearn/issues/592/labels{/name}","comments_url":"https://api.github.com/repos/nilearn/nilearn/issues/592/comments","events_url":"https://api.github.com/repos/nilearn/nilearn/issues/592/events","html_url":"https://github.com/nilearn/nilearn/pull/592","id":78493243,"number":592,"title":"[MRG+1] Backreferences template from sphinx-gallery","user":{"login":"Titan-C","id":713451,"avatar_url":"https://avatars.githubusercontent.com/u/713451?v=3","gravatar_id":"","url":"https://api.github.com/users/Titan-C","html_url":"https://github.com/Titan-C","followers_url":"https://api.github.com/users/Titan-C/followers","following_url":"https://api.github.com/users/Titan-C/following{/other_user}","gists_url":"https://api.github.com/users/Titan-C/gists{/gist_id}","starred_url":"https://api.github.com/users/Titan-C/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Titan-C/subscriptions","organizations_url":"https://api.github.com/users/Titan-C/orgs","repos_url":"https://api.github.com/users/Titan-C/repos","events_url":"https://api.github.com/users/Titan-C/events{/privacy}","received_events_url":"https://api.github.com/users/Titan-C/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":18,"created_at":"2015-05-20T11:50:09Z","updated_at":"2015-11-26T10:22:18Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/nilearn/nilearn/pulls/592","html_url":"https://github.com/nilearn/nilearn/pull/592","diff_url":"https://github.com/nilearn/nilearn/pull/592.diff","patch_url":"https://github.com/nilearn/nilearn/pull/592.patch"},"body":"Here I update to sphinx-gallery with the backreferences solution.\r\nSo now it is possible to use an rst template to document classes and functions including at the end the link to examples using them.\r\nA question of design. Since now this documentation generation is done with default sphinx extention autodoc. It becomes a dependency to have it in the included extensions in the conf.py file.(Not an issue since it was already used by nilearn). But because it is an automatic process all automatic documented classes will try to have the backreferences to example, which might not exist. This issues a warning to during `make`. To workaround this warning scikit-learn and now in this PR, there is an extra action in conf.py that touches non-existing backreference example files so that one does not get the include warning. Question:\r\n* Is this the good way for the user to proceed?(I'll write documentation for this procedure in sphinx-gallery)\r\n* Alternative: have this action as default in sphinx-gallery and require user to always have autodoc extension always loaded?\r\n\r\nMassive renaming in files because:\r\nSince the new naming convention for sphinx-gallery image prefix sphx-glr image references are updated.\r\nSince naming convention for example references is to include the target dir, this references are also updated.\r\n\r\n\r\n"},"comment":{"url":"https://api.github.com/repos/nilearn/nilearn/issues/comments/159869309","html_url":"https://github.com/nilearn/nilearn/pull/592#issuecomment-159869309","issue_url":"https://api.github.com/repos/nilearn/nilearn/issues/592","id":159869309,"user":{"login":"lesteve","id":1680079,"avatar_url":"https://avatars.githubusercontent.com/u/1680079?v=3","gravatar_id":"","url":"https://api.github.com/users/lesteve","html_url":"https://github.com/lesteve","followers_url":"https://api.github.com/users/lesteve/followers","following_url":"https://api.github.com/users/lesteve/following{/other_user}","gists_url":"https://api.github.com/users/lesteve/gists{/gist_id}","starred_url":"https://api.github.com/users/lesteve/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lesteve/subscriptions","organizations_url":"https://api.github.com/users/lesteve/orgs","repos_url":"https://api.github.com/users/lesteve/repos","events_url":"https://api.github.com/users/lesteve/events{/privacy}","received_events_url":"https://api.github.com/users/lesteve/received_events","type":"User","site_admin":false},"created_at":"2015-11-26T10:22:18Z","updated_at":"2015-11-26T10:22:18Z","body":"Thanks a lot.\r\n\r\n> And actually we can see that from a layout / styling perspective, the code line and the output of the script appear as visually similar,\r\n\r\nThere is an issue about that already https://github.com/sphinx-gallery/sphinx-gallery/issues/44"}}