Skip to content
This repository has been archived by the owner on May 28, 2022. It is now read-only.

Use easy_install to install Sphinx? #534

Open
dideler opened this issue Mar 21, 2014 · 9 comments
Open

Use easy_install to install Sphinx? #534

dideler opened this issue Mar 21, 2014 · 9 comments

Comments

@dideler
Copy link
Member

dideler commented Mar 21, 2014

For some reason I was getting the following error on my machine.

sphinx-build -b html -d build/doctrees   source build/html
Traceback (most recent call last):
  File "/usr/local/bin/sphinx-build", line 5, in <module>
    from pkg_resources import load_entry_point
  File "/usr/lib/python2.7/dist-packages/pkg_resources.py", line 2809, in <module>
    parse_requirements(__requires__), Environment()
  File "/usr/lib/python2.7/dist-packages/pkg_resources.py", line 594, in resolve
    raise DistributionNotFound(req)
pkg_resources.DistributionNotFound: Sphinx==1.1.3

Following Sphinx's instructions to install Sphinx using easy_install fixed the problem.

@dideler
Copy link
Member Author

dideler commented Mar 21, 2014

@Freeseer/students can anyone reproduce this? You just need to run the sphinx-build (no arguments necessary). I'm not sure what I did for it to suddenly stop working on my machine.

@bohnje
Copy link
Contributor

bohnje commented Mar 21, 2014

Sorry what exactly are you looking to confirm? That sphinx-build doesn't work and then following the easy-install instructions causes it to work after?

@dideler
Copy link
Member Author

dideler commented Mar 21, 2014

@bohnje sorry, should have been more clear.

Go into the docs/ directory then run pip install -Ur requirements.txt (you might have to use sudo if you're not using virtualenv). Then try to run sphinx-build. You can also try running make html from the docs/ directory, since that calls sphinx-build but with arguments.

I'm more curious about why sphinx-build doesn't work and how to avoid the problem than how to fix it. Maybe we should be using easy_install instead of pip to install Sphinx.

@bohnje
Copy link
Contributor

bohnje commented Mar 21, 2014

Here is the output I get. It doesn't look like I am getting the error you mentioned above.

Note: I had ran the easy install instructions for installing Sphinx before this but I believe I uninstalled it fully using "pip uninstall sphinx" and then followed your new instructions using the requirements.txt.

Running just "sphinx-build":
http://pastebin.com/WP8SYjMY

Running "make html":
http://pastebin.com/rtjHhgtr

@dideler dideler changed the title Use easy_install to install Sphinx Use easy_install to install Sphinx? Mar 21, 2014
@dideler
Copy link
Member Author

dideler commented Mar 21, 2014

@bohnje thanks.

I'll leave this issue open until the cause is known.

@ulemarakki
Copy link

Hello, I had

$ sphinx-build
Traceback (most recent call last):
  File "/usr/local/bin/sphinx-build", line 5, in <module>
    from pkg_resources import load_entry_point
  File "build/bdist.macosx-10.6-intel/egg/pkg_resources.py", line 2797, in <module>

  File "build/bdist.macosx-10.6-intel/egg/pkg_resources.py", line 576, in resolve
    plugin_env, full_env=None, installer=None, fallback=True
pkg_resources.DistributionNotFound: Sphinx==1.1.3

I installed the not founded Sphinx==1.1.3

$ easy_install Sphinx==1.1.3

It solved my problem.
Is it possible that Sphinx==1.1.3 was missed from requirements.txt?

@dideler
Copy link
Member Author

dideler commented Apr 16, 2014

@ulemarakki the requirements file being used allows for any Sphinx version below 2. https://github.com/Freeseer/freeseer/blob/master/docs/requirements.txt

Installing Sphinx via easy_install fixed the problem for me as well. See the issue's description

Following Sphinx's instructions to install Sphinx using easy_install fixed the problem.

But I was interested in what was causing the problem in the first place, since it used to work fine for me until I suddenly got that error one day.

I'm closing this issue for now. If anyone runs into this issue in the future we can reopen.

@dideler dideler closed this as completed Apr 16, 2014
@dideler
Copy link
Member Author

dideler commented Oct 5, 2014

Ran into this issue again. It seems to be fairly common (also happened here #575 (comment)) so I think we should use easy_install for installing Sphinx, which fixes the problem but does add another setup step.

@dideler dideler reopened this Oct 5, 2014
@Centaur
Copy link

Centaur commented May 1, 2015

Same error here. Installing sphinx by Mac OS X build-in python&pip. And after easy_install Sphinx==1.1.3 the error goes away.

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

No branches or pull requests

4 participants