{"action":"created","issue":{"url":"https://api.github.com/repos/scikit-learn/scikit-learn/issues/4658","labels_url":"https://api.github.com/repos/scikit-learn/scikit-learn/issues/4658/labels{/name}","comments_url":"https://api.github.com/repos/scikit-learn/scikit-learn/issues/4658/comments","events_url":"https://api.github.com/repos/scikit-learn/scikit-learn/issues/4658/events","html_url":"https://github.com/scikit-learn/scikit-learn/pull/4658","id":72442948,"number":4658,"title":"[WIP] Sphinx-gallery use","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":8,"created_at":"2015-05-01T14:25:32Z","updated_at":"2015-05-03T23:28:25Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/scikit-learn/scikit-learn/pulls/4658","html_url":"https://github.com/scikit-learn/scikit-learn/pull/4658","diff_url":"https://github.com/scikit-learn/scikit-learn/pull/4658.diff","patch_url":"https://github.com/scikit-learn/scikit-learn/pull/4658.patch"},"body":"This is a proposal to incorporate sphinx-gallery into scikit-learn. There are still some issues to work on so for know one works with the github PR of sphinx-gallery(https://github.com/sphinx-gallery/sphinx-gallery/pull/26) as the main development version.\r\n\r\nTo work on:\r\n- [ ] **Backreferences** The documented API gives at the end of every module a small gallery of the examples using that module. Examples are properly identified but the html output fails recognizing the correct path of the image and the html file. In scikit-learn's gen_rst.py, this paths are hard coded to its website structure. Sphinxgallery uses a configuration dictionary. This issue is mostly solved with  https://github.com/sphinx-gallery/sphinx-gallery/pull/26\r\n\r\n- [ ] **the sidebar hide behavior**. It just messes up with the scikit-learn design. And it is manually deactivated in the gallery implementation with the promise to fix it later:https://github.com/scikit-learn/scikit-learn/blob/master/doc/sphinxext/gen_rst.py#L494-508\r\n\r\n- [ ] **The carousel**: There is an additional image processing step for some images displayed in the carousel done in gen_rst.py, that sphinx-gallery does not perform\r\n\r\n- [ ] **Image naming**: All images generated by sphinx-gallery have a sphx_glr_ prefix. If images of the gallery are manually called by the documentation this would be broken.\r\n\r\n- [ ] More stuff I'm not aware of.\r\n\r\n- [ ] Maybe, as in nilearn, put a local copy of sphinx-gallery inside scikit-learn\r\n \r\n"},"comment":{"url":"https://api.github.com/repos/scikit-learn/scikit-learn/issues/comments/98556097","html_url":"https://github.com/scikit-learn/scikit-learn/pull/4658#issuecomment-98556097","issue_url":"https://api.github.com/repos/scikit-learn/scikit-learn/issues/4658","id":98556097,"user":{"login":"amueller","id":449558,"avatar_url":"https://avatars.githubusercontent.com/u/449558?v=3","gravatar_id":"","url":"https://api.github.com/users/amueller","html_url":"https://github.com/amueller","followers_url":"https://api.github.com/users/amueller/followers","following_url":"https://api.github.com/users/amueller/following{/other_user}","gists_url":"https://api.github.com/users/amueller/gists{/gist_id}","starred_url":"https://api.github.com/users/amueller/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/amueller/subscriptions","organizations_url":"https://api.github.com/users/amueller/orgs","repos_url":"https://api.github.com/users/amueller/repos","events_url":"https://api.github.com/users/amueller/events{/privacy}","received_events_url":"https://api.github.com/users/amueller/received_events","type":"User","site_admin":false},"created_at":"2015-05-03T23:28:25Z","updated_at":"2015-05-03T23:28:25Z","body":"Do you have an idea how we could not rename all inline images? Methinks there are a couple"}}