Skip to content
This repository has been archived by the owner on Nov 11, 2024. It is now read-only.

Make sphinx-astropy an explicit dependency for docs build #472

Closed
bsipocz opened this issue Apr 24, 2019 · 8 comments
Closed

Make sphinx-astropy an explicit dependency for docs build #472

bsipocz opened this issue Apr 24, 2019 · 8 comments
Milestone

Comments

@bsipocz
Copy link
Member

bsipocz commented Apr 24, 2019

Packages relying on astropy-helpers to provide docs building infrastructure should make sphinx-astropy an explicit dependency. Being cleaver and building it and the full dependency three as eggs proved to be problematic when those dependencies start to introduce some version restrictions (e.g. mpl for python, and numpydoc for sphinx) See e.g., #462, #463, #465, etc.

And in addition building the eggs for all those dependencies is the least efficient way to install them (#471)

Now it is a good time to make this change, before the actual v3.2 release.

cc @astrofrog

@astrofrog
Copy link
Member

astrofrog commented Apr 24, 2019

I personally agree, I think it's reasonable to just crash and tell users that sphinx-astropy is needed if it's not installed.

@pllim
Copy link
Member

pllim commented Apr 24, 2019

Where exactly do you want that message? There is already this here

warnings.warn("Note that astropy_helpers.sphinx.conf is deprecated - use sphinx_astropy.conf instead")

@bsipocz bsipocz added this to the v3.2 milestone Apr 24, 2019
@astrofrog
Copy link
Member

I think we should also raise an error here:

https://github.com/astropy/astropy-helpers/blob/master/astropy_helpers/commands/build_sphinx.py#L192

just to be on the safe side (instead of calling ensure_....

@bsipocz
Copy link
Member Author

bsipocz commented Apr 24, 2019

I'll open a PR for this at the end of the today.

@saimn
Copy link
Contributor

saimn commented Apr 24, 2019

And we also have now an explicit dependency with sphinx-asdf, so installing sphinx-astropy under the hood is not enough to build the docs anyway.

@astrofrog
Copy link
Member

Arguably we could make sphinx-asdf a dependency of sphinx-astropy, but let's fix its major performance issues first!

@bsipocz
Copy link
Member Author

bsipocz commented Apr 24, 2019

This was really done for packages other than astropy who use the template and the helpers but not necessarily know what goes on under the hood. astropy always had the explicit dependency on sphinx-astropy listed in setup.py/setup.cfg.

@bsipocz
Copy link
Member Author

bsipocz commented May 3, 2019

Addressed by #474 (and now I realized "address" is not a magic word, so that PR didn't close this issue automatically).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants