#readthedocs

I'd like to use a sphinxcontrib extension, but it's broken on the latest version of Sphinx. Fortunately, there's a PR to fix it, but unfortunately, when I try to install the fixed version from Mercurial, RTD can't install it. Installs just fine for me locally.

Does anyone know what might be going on, or what I can do to debug this further?

build log here: https://readthedocs.org/builds/flask-dance/2490...

I believe that the "Could not import extension sphinx.ext.napoleon" error masks the true error, which is in the "requirements" section of the output

error in sphinxcontrib-aafig setup command: Distribution contains no modules or packages for namespace package 'sphinxcontrib'

er, just realized that no one else will be able to see my build log on RTD, so I've made a gist: https://gist.github.com/singingwolfboy/758422be...

singingwolfboy: what does your requirements.txt look like?

I suppose it’s this https://github.com/singingwolfboy/flask-dance/b...

stevejohnson: that's right

btw your build log is visible to me on rtd

stevejohnson: oh, OK. Good to know

stevejohnson: any idea what the problem might be, or how I can fix it?

singingwolfboy: this is sphinx 1.3?

no ideas yet, just gathering information :-)

I’m currently installing python 2.7 with homebrew since I just upgraded my OS

agj: well, the build log says it's sphinx 1.2.2, even though I'd *like* to use sphinx 1.3

oops, helped if i looked at your req.txt

singingwolfboy: back down 1.2 for now

agj: it seems that when sphinxcontrib-aafig fails to install, it refuses to install sphinx 1.3, either

still working out 1.3 support

agj: are you saying that I should change my requirements file to use sphinx 1.2?

agj: I'm happy to do that, if you think it will help

http://sphinxcontrib-napoleon.readthedocs.org/e... says “As of Sphinx 1.3, the napoleon extension will come packaged with Sphinx under sphinx.ext.napoleon. The sphinxcontrib.napoleon extension will continue to work with Sphinx <= 1.2.”

so if you got sphinx 1.3 to work, you wouldn’t need to put sphinx_contrib in your reqs

singingwolfboy: our doc builder still uses 1.2.2, we're working on 1.3

agj: ah, OK. Let me switch back, then

if you need napolean, i'd try 1.2 with the sphinxcontrib package for now

there are a few changes we need for 1.3 support that we're trying to get to

agj: alright, building now: https://readthedocs.org/builds/flask-dance/2491...

interesting: "Could not import extension sphinxcontrib.napoleon (exception: No module named sphinxcontrib.napoleon)"

that *is* the correct dotpath, isn't it?

hrm. might need to blow away your env

agj: how do I do that?

singingwolfboy: http://docs.readthedocs.org/en/latest/faq.html#...

agj: I got a 404 when I tried to visit https://readthedocs.org/wipe/flask-dance/2491125/

try https://readthedocs.org/wipe/flask-dance/latest/ instead

we should really have this in the UI somewhere

agj: gotcha, that looks more reasonable

agj: OK, just kicked off a new build: https://readthedocs.org/builds/flask-dance/2491...

singingwolfboy: oh my bad, i didn't read lower

looks like requirements install failed all together

agj: yes, that's the problem I was trying to ask about :)

because of aafig

agj: I'm not sure what's wrong with it, though -- the setup.py doesn't look meaningfully different from the setup.py for napoleon

in particular, `namespace_packages=['sphinxcontrib'],`

hrm, yeah not sure

i can reproduce in a fresh virtualenv locally

with sphinx==1.2.2

agj: oh, you can reproduce? I haven't been able to. Let me try specifically sphinx==1.2.2

agj: I just tried again, specifying sphinx==1.2.2, and I still can't reproduce the failure

agj: what version of pip?

pip 1.5.6 on 2.7

using your dev-reqs file

agj: ah-hah! I'm pip 6.0.3

specifically, fails on hg+https://bitbucket.org/espd/sphinx-contrib#eg... requirement

agj: when I install pip 1.5.6, I can reproduce the failure

gotcha

agj: do you know if there's any way to upgrade pip on a RTD build?

agj: I can't just specify it in the requirements file -- it needs to restart the pip process

yeah, that won't be possible

agj: are you a RTD core dev? or just someone who knows a fair amount about it?

yeah, core dev, ericholscher and I run things

agj: what are the chances that we could upgrade pip?

it *probably* wouldn't hurt anything, but we're low bandwidth at the moment with some contracts and planning WTD

and anything that plays with our build servers requires extra eyes

probably worth filing a ticket on upgrading pip, but the packaging issue on that contrib package should probably be resolved

agj: that makes sense

agj: if I had to guess, it's probably something to do with the fact that I'm doing a mercurial clone rather than installing from PyPI

agj: do you happen to know the person to talk to about getting https://bitbucket.org/birkenfeld/sphinx-contrib... merged?

singingwolfboy: hrm, i don't, #sphinx-doc might be of some assistance though

agj: alright, I'll ask there. Thanks!

np :)

agj: I'm going to submit a pull request to upgrade pip. I don't expect it to be merged anytime soon. :)

agj: however, what would be useful for me to include in the PR description?

agj: a link to the failing build?

agj: https://github.com/rtfd/readthedocs.org/pull/1205

ericholscher: hey

I waited for a few days before pinging you specifically

I'm having redirect issues with RTD

I described the issue yesterday and the day before if you scroll up

anyone: ^

I'm getting a lot of questions about why our /latest/ doesn't redirect to the right RTD site

I don't know why these redirects don't work

anyone: ^

bmbouter: you never gave any info about the site or projects to help debug it, afaict

but our redirect code is definitely not the best :)

it depends on 404s at the moment, which might be what you're hitting?

but we're pretty busy at the moment, so support is taking a back seat for now -- if you can write a test case against the codebase that would be the best way to show its broken

hey

I have lots of info on all that

I don't think its broken

so I'm not sure how testing will help

I read the RTD docs on redirect, but they didn't explain what I want to do

it's real simple

http://pulp-user-guide.readthedocs.org/en/latest/ should redirect to http://pulp.readthedocs.org/en/latest/

although for all languages

ericholscher: ^

ah yea, we don't support that because of how our architecture works

we need to move to a javascript based redirect probably -- but that's a worse solution :/

currently we depend on 404s to fall through

but also depend on the project existing to do the redirects -- not an ideal design

but we serve everything directly from nginx for stability reasons

so if a file exists, we serve it

oh ok

so if I delete /latest/ then perhaps these redirects would work

but what about the language. I don't want to redirect for /en/latest/ and /jp/latest/ is there a way I can redirect wildcard or $lang or something

ericholscher: I think that is my last question

https://github.com/rtfd/readthedocs.org/issues/964 shows what I think you want?

ericholscher: it looks related but my redirects weren't in effect at all but this issue says the redirects were working but wrong

oh but I see a fix was applied

so that is why it closed

so this is a realted issue. how is this banner appearing at the top of this page