{"action":"created","issue":{"url":"https://api.github.com/repos/spack/spack/issues/8500","repository_url":"https://api.github.com/repos/spack/spack","labels_url":"https://api.github.com/repos/spack/spack/issues/8500/labels{/name}","comments_url":"https://api.github.com/repos/spack/spack/issues/8500/comments","events_url":"https://api.github.com/repos/spack/spack/issues/8500/events","html_url":"https://github.com/spack/spack/pull/8500","id":333124284,"node_id":"MDExOlB1bGxSZXF1ZXN0MTk1NDE1NTg3","number":8500,"title":"Allow docs to be built with Sphinx 1.7.1+","user":{"login":"adamjstewart","id":12021217,"node_id":"MDQ6VXNlcjEyMDIxMjE3","avatar_url":"https://avatars2.githubusercontent.com/u/12021217?v=4","gravatar_id":"","url":"https://api.github.com/users/adamjstewart","html_url":"https://github.com/adamjstewart","followers_url":"https://api.github.com/users/adamjstewart/followers","following_url":"https://api.github.com/users/adamjstewart/following{/other_user}","gists_url":"https://api.github.com/users/adamjstewart/gists{/gist_id}","starred_url":"https://api.github.com/users/adamjstewart/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/adamjstewart/subscriptions","organizations_url":"https://api.github.com/users/adamjstewart/orgs","repos_url":"https://api.github.com/users/adamjstewart/repos","events_url":"https://api.github.com/users/adamjstewart/events{/privacy}","received_events_url":"https://api.github.com/users/adamjstewart/received_events","type":"User","site_admin":false},"labels":[{"id":446625544,"node_id":"MDU6TGFiZWw0NDY2MjU1NDQ=","url":"https://api.github.com/repos/spack/spack/labels/documentation","name":"documentation","color":"2e81b7","default":false}],"state":"closed","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":2,"created_at":"2018-06-18T03:37:59Z","updated_at":"2018-06-19T21:28:11Z","closed_at":"2018-06-19T00:17:22Z","author_association":"MEMBER","pull_request":{"url":"https://api.github.com/repos/spack/spack/pulls/8500","html_url":"https://github.com/spack/spack/pull/8500","diff_url":"https://github.com/spack/spack/pull/8500.diff","patch_url":"https://github.com/spack/spack/pull/8500.patch"},"body":"Fixes an issue reported by @twang15 in #8491.\r\n\r\n### Before\r\n\r\nIf you try to build Spack's documentation with Sphinx 1.7.1+, you encounter the following error message:\r\n```\r\n$ make\r\nsphinx-build -b html -d _build/doctrees  -E . _build/html\r\nRunning Sphinx v1.7.5\r\nusage: sphinx-build [OPTIONS] -o <OUTPUT_PATH> <MODULE_PATH> [EXCLUDE_PATTERN, ...]\r\nsphinx-build: error: argument -d/--maxdepth: invalid int value: '_build/doctrees'\r\n\r\nConfiguration error:\r\nThe configuration file (or one of the modules it imports) called sys.exit()\r\nmake: *** [html] Error 2\r\n```\r\nThis bug was introduced in https://github.com/sphinx-doc/sphinx/pull/4624, which first appears in Sphinx 1.7.1. See https://github.com/sphinx-doc/sphinx/issues/5104 for the nitty-gritty details.\r\n\r\nThe reason no one has noticed it until now is that we lock down our version of Sphinx to 1.7.0 for the documentation tests.\r\n\r\nAn alternative fix would be to replace `sphinx.apidoc.main` with `sphinx.ext.apidoc.main`. This solution was not chosen because `sphinx.ext.apidoc` did not exist before 1.7.0. This solution _should_ work for all versions of Sphinx, although testing with older versions would be greatly appreciated."},"comment":{"url":"https://api.github.com/repos/spack/spack/issues/comments/398552154","html_url":"https://github.com/spack/spack/pull/8500#issuecomment-398552154","issue_url":"https://api.github.com/repos/spack/spack/issues/8500","id":398552154,"node_id":"MDEyOklzc3VlQ29tbWVudDM5ODU1MjE1NA==","user":{"login":"adamjstewart","id":12021217,"node_id":"MDQ6VXNlcjEyMDIxMjE3","avatar_url":"https://avatars2.githubusercontent.com/u/12021217?v=4","gravatar_id":"","url":"https://api.github.com/users/adamjstewart","html_url":"https://github.com/adamjstewart","followers_url":"https://api.github.com/users/adamjstewart/followers","following_url":"https://api.github.com/users/adamjstewart/following{/other_user}","gists_url":"https://api.github.com/users/adamjstewart/gists{/gist_id}","starred_url":"https://api.github.com/users/adamjstewart/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/adamjstewart/subscriptions","organizations_url":"https://api.github.com/users/adamjstewart/orgs","repos_url":"https://api.github.com/users/adamjstewart/repos","events_url":"https://api.github.com/users/adamjstewart/events{/privacy}","received_events_url":"https://api.github.com/users/adamjstewart/received_events","type":"User","site_admin":false},"created_at":"2018-06-19T21:28:11Z","updated_at":"2018-06-19T21:28:11Z","author_association":"MEMBER","body":"According to one of the leading contributors to Sphinx, `sphinx.ext.apidoc.main` is not a public API and really shouldn't be used for this purpose.\r\n\r\nOther developers have suggested using [sphinx-contrib/apidoc](https://github.com/sphinx-contrib/apidoc) to handle automatic documentation generation. See https://github.com/sphinx-doc/sphinx/pull/5106 for more discussion."}}
{"actor":{"display_login":"adamjstewart"}}