Repository navigation
Fix RTD build - #4915
Fix RTD build#4915
Conversation
|
@eteq - I'll look into all this tomorrow |
|
ah that's the reason why I cannot build the documentation locally anymore. Apart from fixing RTD would it be possible to skip the gallery build if the sphinx-gallery isn't avaiable - instead of crashing the documentation build? Or should I open another issue for this? |
|
@MSeifert04 - good idea on that last part... But I'm not sure if it's possible. This is a sphinx extension, so we'd have to like remove it from the extension list if it turns out the user doesn't have it installed? Not sure if that has more substansive unintended consequences... @adrn? |
|
@MSeifert04 @eteq Hmm that does sound like a good idea in principle, but I don't know how that could be done without some major sphinx hacks that I'm not really comfortable suggesting... |
|
Aha - thanks for the pointer @astrofrog - this one seems to have worked (https://readthedocs.org/projects/eteq-astropy/builds/4004580/) So if we merge this now it should fix the build right now. Note that for other reasons I think the pip requirements might be good - see #4916. But that can be done in addition to this. |
|
Alright, I'm going to merge this just to get the RTD build back in order. But please discuss in #4916 if you think the added pip requirements are a good idea, and #4924 if you like @MSeifert04's idea of letting it build w/o the gallery. |
The initial impetus for this was to fix ReadTheDocs, which was broken some time in the freature freeze flurry yesterday. The root cause is that the docs now require
sphinx-gallery(and possiblyjplephem), both of which are not on conda (which is used by RTD in our current setup to install dependencies).They are on pip, so this PR tries to solve the problem by ressurrecting the pip requirements file and using that in addition to the conda requirements. The problem is... it doesn't seem to work. If you check out this build report, you'll see that it's still refusing to use the pip requirements file, despite it being added to the RTD YAML file. I think it was @astrofrog that first set this up, right? Any ideas on how to fix this?
Another possible solution is to just put sphinx-gallery (and jplephem if needed) on the astropy conda channel. Then the pip stuff is no longer necessary. @mwcraig or @bsipocz, any thoughts on that?