Add troubleshooting sphinx tip #652

Closed
wants to merge 1 commit into from

4 participants

@joequery

I had sphinx installed system-wide, and I could not build the docs despite running python setup.py develop in my virtualenv.

I eventually figured out that sphinx installed system wide wouldn't place nicely with the Flask package installed in the virtualenv. This wasn't obvious from the provided error message, so I'd like to improve the error message.

@sigmavirus24

I'm not entirely certain this is necessary. It can not hurt per se, but I don't see it as being useful.

@kennethreitz

Agreed, I'm 👎 on this. Thanks, though!

@joequery

Meh, I spent 20-30 minutes or so fumbling around due to this. Oh well, I guess I'll just write an article and hope people come across it when they have this issue.

@sigmavirus24
@joequery

--no-site-packages applies to things you're importing, not executables that are part of your PATH. --no-site-packages is default behavior in virtualenv anyway. The reason why the error felt so weird was because the location of an executable usually doesn't matter.

@sigmavirus24
@joequery

Why should anyone need to know all that in order to just build documentation?

@sigmavirus24

If everything is installed in the virtualenv then they don't need to know that. If they, however, plan to do any serious amount of varied python development, it's helpful to know what the tools you're using actually do.

@joequery

Whatever. You clearly just want an outlet to be as condescending as possible. I'll delete the branch and be done with this thread. You "win", congrats.

@boris317

I really dont think sigmavirus24 was trying to be condescending. The issue you ran into is not unique to Sphinx. This could happen with any package that installs an "executable". This is really a subtlety of virtualenv.

@sigmavirus24

@boris317 I had no desire to be condescending. I know telling people to read the documentation often comes off as overly-critical which is why I prefaced my first response with the assertion that I had no ill will. I had only the desire to explain this to Joe but perhaps I somehow used language that came off as harsh or condescending. I intended to leave this be and let it cool down until some later date. But I may as well respond now and apologize to Joe regardless. I am sorry that I came off as condescending, I was merely trying to be informative and helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment