{"action":"created","issue":{"url":"https://api.github.com/repos/scikit-learn/scikit-learn/issues/10064","repository_url":"https://api.github.com/repos/scikit-learn/scikit-learn","labels_url":"https://api.github.com/repos/scikit-learn/scikit-learn/issues/10064/labels{/name}","comments_url":"https://api.github.com/repos/scikit-learn/scikit-learn/issues/10064/comments","events_url":"https://api.github.com/repos/scikit-learn/scikit-learn/issues/10064/events","html_url":"https://github.com/scikit-learn/scikit-learn/issues/10064","id":271017512,"number":10064,"title":"DOC missing requirements for building documentation","user":{"login":"rth","id":630936,"avatar_url":"https://avatars0.githubusercontent.com/u/630936?v=4","gravatar_id":"","url":"https://api.github.com/users/rth","html_url":"https://github.com/rth","followers_url":"https://api.github.com/users/rth/followers","following_url":"https://api.github.com/users/rth/following{/other_user}","gists_url":"https://api.github.com/users/rth/gists{/gist_id}","starred_url":"https://api.github.com/users/rth/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rth/subscriptions","organizations_url":"https://api.github.com/users/rth/orgs","repos_url":"https://api.github.com/users/rth/repos","events_url":"https://api.github.com/users/rth/events{/privacy}","received_events_url":"https://api.github.com/users/rth/received_events","type":"User","site_admin":false},"labels":[{"id":12995770,"url":"https://api.github.com/repos/scikit-learn/scikit-learn/labels/Documentation","name":"Documentation","color":"0b02e1","default":false},{"id":12995769,"url":"https://api.github.com/repos/scikit-learn/scikit-learn/labels/Easy","name":"Easy","color":"02d7e1","default":false},{"id":723599497,"url":"https://api.github.com/repos/scikit-learn/scikit-learn/labels/help%20wanted","name":"help wanted","color":"33aa3f","default":true}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":2,"created_at":"2017-11-03T15:26:42Z","updated_at":"2017-12-08T00:17:52Z","closed_at":null,"author_association":"MEMBER","body":"The [instructions to build the documentation](http://scikit-learn.org/dev/developers/contributing.html#documentation) suggest,\r\n\r\n>  For building the documentation, you will need sphinx, matplotlib and pillow.\r\n\r\nyet `numpydoc` also appear to be a requirement (tested on `master` with Python 3.6 and sphinx 1.6.3),\r\n```\r\nmake html                                                                                                     [doc-version] \r\n# These two lines make the build a bit more lengthy, and the\r\n# the embedding of images more robust\r\nrm -rf _build/html/_images\r\n#rm -rf _build/doctrees/\r\nsphinx-build -b html -d _build/doctrees   . _build/html/stable\r\nRunning Sphinx v1.6.3\r\n\r\nExtension error:\r\nCould not import extension numpydoc (exception: No module named 'numpydoc')\r\nmake: *** [Makefile:42: html] Error 1\r\n```\r\nthen if it's installed,\r\n```\r\nExtension error:\r\nCould not import extension sphinx_gallery.gen_gallery (exception: No module named 'sphinx_gallery.gen_gallery')\r\nmake: *** [Makefile:42: html] Error 1\r\n```\r\nIf confirmed, `numpydoc` and `sphinx-gallery` requirements would need to be added to `doc/developers/contributing.rst` and `doc/README.md`.\r\n\r\nHaving e.g. a `documentation_requrements.txt` somewhere with all the requirements to build the docs (one per line) could also be handy? It could be used from `build_tools/circle/build_doc.sh` to install the requirements with pip or conda to avoid divergences between the documentation and the CI build in the future.."},"comment":{"url":"https://api.github.com/repos/scikit-learn/scikit-learn/issues/comments/350134815","html_url":"https://github.com/scikit-learn/scikit-learn/issues/10064#issuecomment-350134815","issue_url":"https://api.github.com/repos/scikit-learn/scikit-learn/issues/10064","id":350134815,"user":{"login":"jrbourbeau","id":11656932,"avatar_url":"https://avatars1.githubusercontent.com/u/11656932?v=4","gravatar_id":"","url":"https://api.github.com/users/jrbourbeau","html_url":"https://github.com/jrbourbeau","followers_url":"https://api.github.com/users/jrbourbeau/followers","following_url":"https://api.github.com/users/jrbourbeau/following{/other_user}","gists_url":"https://api.github.com/users/jrbourbeau/gists{/gist_id}","starred_url":"https://api.github.com/users/jrbourbeau/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jrbourbeau/subscriptions","organizations_url":"https://api.github.com/users/jrbourbeau/orgs","repos_url":"https://api.github.com/users/jrbourbeau/repos","events_url":"https://api.github.com/users/jrbourbeau/events{/privacy}","received_events_url":"https://api.github.com/users/jrbourbeau/received_events","type":"User","site_admin":false},"created_at":"2017-12-08T00:17:52Z","updated_at":"2017-12-08T00:17:52Z","author_association":"CONTRIBUTOR","body":"I also like how the scikit-image requirements files are centralized. \r\n\r\nIf this is the direction people want to go, I can work on making a `requirements` directory and updating the CI files and relevant documentation.  "}}
{"actor":{"display_login":"jrbourbeau"}}