{"action":"created","issue":{"url":"https://api.github.com/repos/astropy/astropy-helpers/issues/368","repository_url":"https://api.github.com/repos/astropy/astropy-helpers","labels_url":"https://api.github.com/repos/astropy/astropy-helpers/issues/368/labels{/name}","comments_url":"https://api.github.com/repos/astropy/astropy-helpers/issues/368/comments","events_url":"https://api.github.com/repos/astropy/astropy-helpers/issues/368/events","html_url":"https://github.com/astropy/astropy-helpers/pull/368","id":292462978,"number":368,"title":"Remove all sphinx components","user":{"login":"astrofrog","id":314716,"avatar_url":"https://avatars2.githubusercontent.com/u/314716?v=4","gravatar_id":"","url":"https://api.github.com/users/astrofrog","html_url":"https://github.com/astrofrog","followers_url":"https://api.github.com/users/astrofrog/followers","following_url":"https://api.github.com/users/astrofrog/following{/other_user}","gists_url":"https://api.github.com/users/astrofrog/gists{/gist_id}","starred_url":"https://api.github.com/users/astrofrog/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/astrofrog/subscriptions","organizations_url":"https://api.github.com/users/astrofrog/orgs","repos_url":"https://api.github.com/users/astrofrog/repos","events_url":"https://api.github.com/users/astrofrog/events{/privacy}","received_events_url":"https://api.github.com/users/astrofrog/received_events","type":"User","site_admin":false},"labels":[{"id":643944711,"url":"https://api.github.com/repos/astropy/astropy-helpers/labels/sphinx","name":"sphinx","color":"1d76db","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":{"url":"https://api.github.com/repos/astropy/astropy-helpers/milestones/32","html_url":"https://github.com/astropy/astropy-helpers/milestone/32","labels_url":"https://api.github.com/repos/astropy/astropy-helpers/milestones/32/labels","id":3008639,"number":32,"title":"v3.1.0","description":"","creator":{"login":"bsipocz","id":6788290,"avatar_url":"https://avatars1.githubusercontent.com/u/6788290?v=4","gravatar_id":"","url":"https://api.github.com/users/bsipocz","html_url":"https://github.com/bsipocz","followers_url":"https://api.github.com/users/bsipocz/followers","following_url":"https://api.github.com/users/bsipocz/following{/other_user}","gists_url":"https://api.github.com/users/bsipocz/gists{/gist_id}","starred_url":"https://api.github.com/users/bsipocz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bsipocz/subscriptions","organizations_url":"https://api.github.com/users/bsipocz/orgs","repos_url":"https://api.github.com/users/bsipocz/repos","events_url":"https://api.github.com/users/bsipocz/events{/privacy}","received_events_url":"https://api.github.com/users/bsipocz/received_events","type":"User","site_admin":false},"open_issues":2,"closed_issues":2,"state":"open","created_at":"2018-01-02T20:08:14Z","updated_at":"2018-01-31T18:15:56Z","due_on":null,"closed_at":null},"comments":2,"created_at":"2018-01-29T16:04:01Z","updated_at":"2018-02-01T13:14:40Z","closed_at":null,"author_association":"OWNER","pull_request":{"url":"https://api.github.com/repos/astropy/astropy-helpers/pulls/368","html_url":"https://github.com/astropy/astropy-helpers/pull/368","diff_url":"https://github.com/astropy/astropy-helpers/pull/368.diff","patch_url":"https://github.com/astropy/astropy-helpers/pull/368.patch"},"body":"### Overview\r\n\r\nThis is a more extensive alternative to #367, and it:\r\n\r\n* Removes the theme which is in https://github.com/astropy/astropy-sphinx-theme (and on PyPI)\r\n* Removes the bundled sphinx-automodapi and numpydoc\r\n* Removes the rest of ``astropy_helpers.sphinx`` to https://github.com/astropy/sphinx-astropy\r\n\r\nIt does **not** remove ``build_docs`` though.\r\n\r\nNote that the astropy-sphinx-theme and sphinx-astropy repositories contain the full history of the files in those repos, including their origins in the astropy core package. I am publishing the scripts I used to do all this here: https://github.com/astrofrog/git-workflows (note that this isn't up to date yet as I have some more changes to push).\r\n\r\nNote that sphinx-astropy is also a meta-package in that it includes dependencies on astropy-sphinx-theme, sphinx-automodapi, numpydoc, and sphinx-gallery. I haven't published sphinx-astropy yet as I want to make sure we have a chance to discuss this here first.\r\n\r\n### Backward-compatibility\r\n\r\nThese changes will require one change in astropy core and affiliated packages (when they update to astropy-helpers next), which to change this line:\r\n\r\nhttps://github.com/astropy/astropy/blob/master/docs/conf.py#L48\r\n\r\nfrom:\r\n\r\n```python\r\nfrom astropy_helpers.sphinx.conf import *\r\n```\r\n\r\nto\r\n\r\n```python\r\nfrom sphinx_astropy.conf import *\r\n```\r\n\r\nNote that we can make this change automatically when updating astropy-helpers. We could optionally add a nicer error message:\r\n\r\n```python\r\ntry:\r\n    from sphinx_astropy.conf import *\r\nexcept ImportError:\r\n    print('Note that the documentation for this package requires the sphinx-astropy package to be installed')\r\n    sys.exit(1)\r\n```\r\n\r\nThis has the benefit of being super explicit in terms of what is required, which is an improvement over just the logging warning in #367.\r\n\r\nSee https://github.com/astropy/astropy/pull/7139 for an example implementation in the core package.\r\n\r\nI don't *think* we need to add a compatibility layer to astropy-helpers since in principle packages will be able to update their ``conf.py`` at the same time as the astropy-helpers submodule.\r\n\r\n### Steps forward\r\n\r\nIf we agree on this, these are the steps ahead:\r\n\r\n* [x] Merge https://github.com/astropy/sphinx-astropy/pull/2\r\n* [ ] Do a release of the sphinx-astropy package\r\n* [ ] Update this PR to use the released sphinx-astropy package\r\n* [ ] Determine if the Travis matrix can be simplified (fewer sphinx versions)\r\n* [ ] Open a PR to astropy core to use sphinx-astropy instead of astropy-helpers in conf.py, and mention dependency on sphinx-astropy to build the docs (https://github.com/astropy/astropy/pull/7139)\r\n* [ ] Open a PR to the package template to use sphinx-astropy instead of astropy-helpers in conf.py\r\n\r\nFixes https://github.com/astropy/astropy-helpers/issues/338\r\nFixes https://github.com/astropy/astropy-helpers/issues/339\r\n\r\nThe following issue should probably be moved to sphinx-astropy, or at least resolved there then closed here: https://github.com/astropy/astropy-helpers/issues/270, https://github.com/astropy/astropy-helpers/issues/195, https://github.com/astropy/astropy-helpers/issues/211, https://github.com/astropy/astropy-helpers/issues/233, https://github.com/astropy/astropy-helpers/issues/320, https://github.com/astropy/astropy-helpers/issues/327\r\n\r\nThe following issue should probably be in sphinx-automodapi; https://github.com/astropy/astropy-helpers/issues/276"},"comment":{"url":"https://api.github.com/repos/astropy/astropy-helpers/issues/comments/362262183","html_url":"https://github.com/astropy/astropy-helpers/pull/368#issuecomment-362262183","issue_url":"https://api.github.com/repos/astropy/astropy-helpers/issues/368","id":362262183,"user":{"login":"bsipocz","id":6788290,"avatar_url":"https://avatars1.githubusercontent.com/u/6788290?v=4","gravatar_id":"","url":"https://api.github.com/users/bsipocz","html_url":"https://github.com/bsipocz","followers_url":"https://api.github.com/users/bsipocz/followers","following_url":"https://api.github.com/users/bsipocz/following{/other_user}","gists_url":"https://api.github.com/users/bsipocz/gists{/gist_id}","starred_url":"https://api.github.com/users/bsipocz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bsipocz/subscriptions","organizations_url":"https://api.github.com/users/bsipocz/orgs","repos_url":"https://api.github.com/users/bsipocz/repos","events_url":"https://api.github.com/users/bsipocz/events{/privacy}","received_events_url":"https://api.github.com/users/bsipocz/received_events","type":"User","site_admin":false},"created_at":"2018-02-01T13:14:40Z","updated_at":"2018-02-01T13:14:40Z","author_association":"MEMBER","body":"I really like this refactoring, but have a few questions left.\r\n\r\nDo we plan to pin sphinx-astropy's version in the helpers releases? I just wonder about scenarios when it's not safe or desired by affiliated packages to upgrade to the latest sphinx-astropy. Since having this factored out, the overall complexity of the helpers package hierarchy is growing that may cause further confusion."}}
{"actor":{"display_login":"bsipocz"}}