{"action":"created","issue":{"url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/4606","repository_url":"https://api.github.com/repos/sphinx-doc/sphinx","labels_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/4606/labels{/name}","comments_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/4606/comments","events_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/4606/events","html_url":"https://github.com/sphinx-doc/sphinx/issues/4606","id":296517478,"number":4606,"title":"\"Unexpected indentation\" warnings from :members:","user":{"login":"asmeurer","id":71486,"avatar_url":"https://avatars3.githubusercontent.com/u/71486?v=4","gravatar_id":"","url":"https://api.github.com/users/asmeurer","html_url":"https://github.com/asmeurer","followers_url":"https://api.github.com/users/asmeurer/followers","following_url":"https://api.github.com/users/asmeurer/following{/other_user}","gists_url":"https://api.github.com/users/asmeurer/gists{/gist_id}","starred_url":"https://api.github.com/users/asmeurer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/asmeurer/subscriptions","organizations_url":"https://api.github.com/users/asmeurer/orgs","repos_url":"https://api.github.com/users/asmeurer/repos","events_url":"https://api.github.com/users/asmeurer/events{/privacy}","received_events_url":"https://api.github.com/users/asmeurer/received_events","type":"User","site_admin":false},"labels":[{"id":162415664,"url":"https://api.github.com/repos/sphinx-doc/sphinx/labels/autodoc","name":"autodoc","color":"FFFFFF","default":false},{"id":162407998,"url":"https://api.github.com/repos/sphinx-doc/sphinx/labels/question","name":"question","color":"cc317c","default":true}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":3,"created_at":"2018-02-12T20:43:34Z","updated_at":"2018-02-13T15:44:45Z","closed_at":null,"author_association":"NONE","body":"Since Sphinx updated to 1.7.0, our SymPy docs started failing. We have the setting enabled in our docs to turn warnings into errors. \r\n\r\nWe have gotten many errors like\r\n\r\n```\r\nWarning, treated as error:\r\n/home/travis/build/sympy/sympy/sympy/codegen/cfunctions.py:docstring of sympy.codegen.cfunctions.exp2.eval:15:Unexpected indentation.\r\nmake: *** [html] Error 2\r\n```\r\n\r\nIt turns out the source of the error has nothing to do with the method in question (which doesn't even have a docstring). The problem is that we used\r\n\r\n```\r\n.. automodule:: sympy.codegen.cfunctions\r\n    :members:\r\n```\r\n\r\ninstead of\r\n\r\n```\r\n.. automodule:: sympy.codegen.cfunctions\r\n\r\n   :members:\r\n```\r\n\r\nThis is requiring changes across our entire docs.\r\n\r\nNow if Sphinx wants to require the newline here, that is fine. But the warning should be much more indicative of what the problem is. Also, quite annoyingly, it only warns about one issue at a time, so if you fix an issue and rebuild, it will warn about another one (and for whatever reason, Sphinx no longer caches the build??? Every build is done from scratch. This is even if I make no changes to anything). \r\n\r\nI tested this against the master branch and it is the same result. \r\n\r\nUpstream SymPy issue: https://github.com/sympy/sympy/pull/14181"},"comment":{"url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/comments/365306319","html_url":"https://github.com/sphinx-doc/sphinx/issues/4606#issuecomment-365306319","issue_url":"https://api.github.com/repos/sphinx-doc/sphinx/issues/4606","id":365306319,"user":{"login":"tk0miya","id":748828,"avatar_url":"https://avatars2.githubusercontent.com/u/748828?v=4","gravatar_id":"","url":"https://api.github.com/users/tk0miya","html_url":"https://github.com/tk0miya","followers_url":"https://api.github.com/users/tk0miya/followers","following_url":"https://api.github.com/users/tk0miya/following{/other_user}","gists_url":"https://api.github.com/users/tk0miya/gists{/gist_id}","starred_url":"https://api.github.com/users/tk0miya/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/tk0miya/subscriptions","organizations_url":"https://api.github.com/users/tk0miya/orgs","repos_url":"https://api.github.com/users/tk0miya/repos","events_url":"https://api.github.com/users/tk0miya/events{/privacy}","received_events_url":"https://api.github.com/users/tk0miya/received_events","type":"User","site_admin":false},"created_at":"2018-02-13T15:44:45Z","updated_at":"2018-02-13T15:44:45Z","author_association":"OWNER","body":">I think there is a bug here, which is that the error reporting from Sphinx is not very good. It would help a lot if it named the actual function that the docstring came from (Function.eval instead of exp2.eval).\r\n\r\nAbsolutely. The messages should be improved.\r\n\r\n>There's also the warnings as errors only appearing one at a time issue I mentioned, but that can be a separate issue if you want.\r\n\r\nYes please!"}}
{"actor":{"display_login":"tk0miya"}}