Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make Sphinx autodoc use local, not system-wide Scrapy #1335

Merged
merged 2 commits into from Jul 30, 2015

Conversation

@jdemaeyer
Copy link
Contributor

@jdemaeyer jdemaeyer commented Jul 3, 2015

This is more a question than a 'definitive' pull request. Without this line, Sphinx' autodoc extension uses my system-wide Scrapy installation (in my case, from /usr/lib/python2.7/site-packages/scrapy) instead of the one in my git working directory.

While I guess this is not a problem for the server which builds the docs from a current repository copy and probably doesn't have a system-wide Scrapy installation, it does build docs from the (possibly outdated) system-wide doctrings for me (w/ make html), and throws errors when I add new functions/classes and document them with autodoc. I don't quite see how it could be, but is this specific to my setup?

@@ -19,6 +19,7 @@
# absolute, like shown here.
sys.path.append(path.join(path.dirname(__file__), "_ext"))
sys.path.append(path.join(path.dirname(path.dirname(__file__)), "scrapy"))

This comment has been minimized.

@jdemaeyer

jdemaeyer Jul 3, 2015
Author Contributor

Also, I'm confused what this line is for? Are any Scrapy submodules ever referenced without scrapy. prefixed? Removing it creates no errors on my system.

This comment has been minimized.

@kmike

kmike Jul 29, 2015
Member

I think it is an error, and the intention was the same as in your PR.

This comment has been minimized.

@jdemaeyer

jdemaeyer Jul 30, 2015
Author Contributor

Ah, I see. In that case I guess it's fine to remove it?

kmike added a commit that referenced this pull request Jul 30, 2015
Make Sphinx autodoc use local, not system-wide Scrapy
@kmike kmike merged commit b6eb340 into scrapy:master Jul 30, 2015
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants