diff --git a/scrapy/conf/default_settings.py b/scrapy/conf/default_settings.py index c6d956e63..637f09500 100644 --- a/scrapy/conf/default_settings.py +++ b/scrapy/conf/default_settings.py @@ -2,14 +2,14 @@ This module contains the default values for all settings used by Scrapy. For more information about these settings you can read the settings -documentation in docs/ref/settings.rst +documentation in docs/topics/settings.rst Scrapy developers, if you add a setting here remember to: * add it in alphabetical order * group similar settings without leaving blank lines * add its documentation to the available settings documentation - (docs/ref/settings.rst) + (docs/topics/settings.rst) """ diff --git a/scrapy/contrib/closedomain.py b/scrapy/contrib/closedomain.py index 74f9b4ca1..2bd9b02d8 100644 --- a/scrapy/contrib/closedomain.py +++ b/scrapy/contrib/closedomain.py @@ -1,7 +1,7 @@ """CloseDomain is an extension that forces spiders to be closed after certain conditions are met. -See documentation in docs/ref/extensions.rst +See documentation in docs/topics/extensions.rst """ from collections import defaultdict diff --git a/scrapy/contrib/debug.py b/scrapy/contrib/debug.py index 075bddf3e..9a4fa9764 100644 --- a/scrapy/contrib/debug.py +++ b/scrapy/contrib/debug.py @@ -1,7 +1,7 @@ """ Extensions for debugging Scrapy -See documentation in docs/ref/extensions.rst +See documentation in docs/topics/extensions.rst """ import signal import traceback diff --git a/scrapy/contrib/downloadermiddleware/defaultheaders.py b/scrapy/contrib/downloadermiddleware/defaultheaders.py index dc95c2f9f..cebfe247b 100644 --- a/scrapy/contrib/downloadermiddleware/defaultheaders.py +++ b/scrapy/contrib/downloadermiddleware/defaultheaders.py @@ -1,7 +1,7 @@ """ DefaultHeaders downloader middleware -See documentation in docs/ref/downloader-middleware.rst +See documentation in docs/topics/downloader-middleware.rst """ from scrapy.conf import settings diff --git a/scrapy/contrib/downloadermiddleware/httpauth.py b/scrapy/contrib/downloadermiddleware/httpauth.py index e9acc8b37..4834c490f 100644 --- a/scrapy/contrib/downloadermiddleware/httpauth.py +++ b/scrapy/contrib/downloadermiddleware/httpauth.py @@ -1,7 +1,7 @@ """ HTTP basic auth downloader middleware -See documentation in docs/ref/downloader-middleware.rst +See documentation in docs/topics/downloader-middleware.rst """ from scrapy.utils.request import request_authenticate diff --git a/scrapy/contrib/linkextractors/__init__.py b/scrapy/contrib/linkextractors/__init__.py index cb4077655..47f6e3148 100644 --- a/scrapy/contrib/linkextractors/__init__.py +++ b/scrapy/contrib/linkextractors/__init__.py @@ -3,5 +3,5 @@ scrapy.contrib.linkextractors This package contains a collection of Link Extractors. -For more info see docs/ref/link-extractors.rst +For more info see docs/topics/link-extractors.rst """ diff --git a/scrapy/contrib/memdebug.py b/scrapy/contrib/memdebug.py index 7bdad55fb..b9f56f01d 100644 --- a/scrapy/contrib/memdebug.py +++ b/scrapy/contrib/memdebug.py @@ -1,7 +1,7 @@ """ MemoryDebugger extension -See documentation in docs/ref/extensions.rst +See documentation in docs/topics/extensions.rst """ import gc diff --git a/scrapy/contrib/memusage.py b/scrapy/contrib/memusage.py index ca7d9d9a2..38fe1e643 100644 --- a/scrapy/contrib/memusage.py +++ b/scrapy/contrib/memusage.py @@ -1,7 +1,7 @@ """ MemoryUsage extension -See documentation in docs/ref/extensions.rst +See documentation in docs/topics/extensions.rst """ import os diff --git a/scrapy/contrib/schedulermiddleware/duplicatesfilter.py b/scrapy/contrib/schedulermiddleware/duplicatesfilter.py index c0ac145a3..d9fff5c00 100644 --- a/scrapy/contrib/schedulermiddleware/duplicatesfilter.py +++ b/scrapy/contrib/schedulermiddleware/duplicatesfilter.py @@ -1,7 +1,7 @@ """ DuplicatesFilterMiddleware: Filter out already visited urls -See documentation in docs/ref/scheduler-middleware.rst +See documentation in docs/topics/scheduler-middleware.rst """ from scrapy.core.exceptions import IgnoreRequest, NotConfigured diff --git a/scrapy/contrib/spidermiddleware/depth.py b/scrapy/contrib/spidermiddleware/depth.py index f91da1039..8d550ab61 100644 --- a/scrapy/contrib/spidermiddleware/depth.py +++ b/scrapy/contrib/spidermiddleware/depth.py @@ -1,7 +1,7 @@ """ Depth Spider Middleware -See documentation in docs/ref/spider-middleware.rst +See documentation in docs/topics/spider-middleware.rst """ from scrapy import log diff --git a/scrapy/contrib/spidermiddleware/httperror.py b/scrapy/contrib/spidermiddleware/httperror.py index c4cbf8035..78cecfdf7 100644 --- a/scrapy/contrib/spidermiddleware/httperror.py +++ b/scrapy/contrib/spidermiddleware/httperror.py @@ -1,7 +1,7 @@ """ HttpError Spider Middleware -See documentation in docs/ref/spider-middleware.rst +See documentation in docs/topics/spider-middleware.rst """ class HttpErrorMiddleware(object): diff --git a/scrapy/contrib/spidermiddleware/offsite.py b/scrapy/contrib/spidermiddleware/offsite.py index a540919bf..2d766ddc9 100644 --- a/scrapy/contrib/spidermiddleware/offsite.py +++ b/scrapy/contrib/spidermiddleware/offsite.py @@ -1,7 +1,7 @@ """ Offsite Spider Middleware -See documentation in docs/ref/spider-middleware.rst +See documentation in docs/topics/spider-middleware.rst """ import re diff --git a/scrapy/contrib/spidermiddleware/requestlimit.py b/scrapy/contrib/spidermiddleware/requestlimit.py index edbd9a9c7..4da230a6b 100644 --- a/scrapy/contrib/spidermiddleware/requestlimit.py +++ b/scrapy/contrib/spidermiddleware/requestlimit.py @@ -1,7 +1,7 @@ """ Request Limit Spider middleware -See documentation in docs/ref/spider-middleware.rst +See documentation in docs/topics/spider-middleware.rst """ from itertools import imap from scrapy.xlib.pydispatch import dispatcher diff --git a/scrapy/contrib/spidermiddleware/restrict.py b/scrapy/contrib/spidermiddleware/restrict.py index a48ebfe7f..17f6b8113 100644 --- a/scrapy/contrib/spidermiddleware/restrict.py +++ b/scrapy/contrib/spidermiddleware/restrict.py @@ -1,7 +1,7 @@ """ Restrict Spider Middleware -See documentation in docs/ref/spider-middleware.rst +See documentation in docs/topics/spider-middleware.rst """ from itertools import ifilter diff --git a/scrapy/contrib/spidermiddleware/urllength.py b/scrapy/contrib/spidermiddleware/urllength.py index cbdb022a6..148d3ad84 100644 --- a/scrapy/contrib/spidermiddleware/urllength.py +++ b/scrapy/contrib/spidermiddleware/urllength.py @@ -1,7 +1,7 @@ """ Url Length Spider Middleware -See documentation in docs/ref/spider-middleware.rst +See documentation in docs/topics/spider-middleware.rst """ from scrapy import log diff --git a/scrapy/contrib/spiders/crawl.py b/scrapy/contrib/spiders/crawl.py index 4f7115da8..b07853568 100644 --- a/scrapy/contrib/spiders/crawl.py +++ b/scrapy/contrib/spiders/crawl.py @@ -2,7 +2,7 @@ This modules implements the CrawlSpider which is the recommended spider to use for scraping typical web sites that requires crawling pages. -See documentation in docs/ref/spiders.rst +See documentation in docs/topics/spiders.rst """ import copy diff --git a/scrapy/contrib/spiders/feed.py b/scrapy/contrib/spiders/feed.py index 2991fd557..d456022c4 100644 --- a/scrapy/contrib/spiders/feed.py +++ b/scrapy/contrib/spiders/feed.py @@ -2,7 +2,7 @@ This module implements the XMLFeedSpider which is the recommended spider to use for scraping from an XML feed. -See documentation in docs/ref/spiders.rst +See documentation in docs/topics/spiders.rst """ from scrapy.contrib.spiders.init import InitSpider diff --git a/scrapy/contrib/webconsole/scheduler.py b/scrapy/contrib/webconsole/scheduler.py index 805e3423c..d94db13ac 100644 --- a/scrapy/contrib/webconsole/scheduler.py +++ b/scrapy/contrib/webconsole/scheduler.py @@ -1,7 +1,7 @@ """ Scheduler queue web console module -See documentation in docs/ref/extensions.rst +See documentation in docs/topics/extensions.rst """ from scrapy.xlib.pydispatch import dispatcher diff --git a/scrapy/core/exceptions.py b/scrapy/core/exceptions.py index 6b172c57d..e1fbd6f85 100644 --- a/scrapy/core/exceptions.py +++ b/scrapy/core/exceptions.py @@ -1,7 +1,7 @@ """ Scrapy core exceptions -These exceptions are documented in docs/ref/exceptions.rst. Please don't add +These exceptions are documented in docs/topics/exceptions.rst. Please don't add new exceptions here without documenting them there. """ diff --git a/scrapy/core/signals.py b/scrapy/core/signals.py index 0077140ca..0cdee5500 100644 --- a/scrapy/core/signals.py +++ b/scrapy/core/signals.py @@ -1,7 +1,7 @@ """ Scrapy core signals -These signals are documented in docs/ref/signals.rst. Please don't add new +These signals are documented in docs/topics/signals.rst. Please don't add new signals here without documenting them there. """ diff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.py index bb4691a44..00bd88759 100644 --- a/scrapy/http/request/__init__.py +++ b/scrapy/http/request/__init__.py @@ -2,7 +2,7 @@ This module implements the Request class which is used to represent HTTP requests in Scrapy. -See documentation in docs/ref/request-response.rst +See documentation in docs/topics/request-response.rst """ import copy diff --git a/scrapy/http/request/form.py b/scrapy/http/request/form.py index e7a654ab9..ab4784d5d 100644 --- a/scrapy/http/request/form.py +++ b/scrapy/http/request/form.py @@ -2,7 +2,7 @@ This module implements the FormRequest class which is a more covenient class (than Request) to generate Requests based on form data. -See documentation in docs/ref/request-response.rst +See documentation in docs/topics/request-response.rst """ import urllib diff --git a/scrapy/http/request/rpc.py b/scrapy/http/request/rpc.py index 64b4459f8..e3dbd2816 100644 --- a/scrapy/http/request/rpc.py +++ b/scrapy/http/request/rpc.py @@ -2,7 +2,7 @@ This module implements the XmlRpcRequest class which is a more convenient class (that Request) to generate xml-rpc requests. -See documentation in docs/ref/request-response.rst +See documentation in docs/topics/request-response.rst """ import xmlrpclib diff --git a/scrapy/http/response/__init__.py b/scrapy/http/response/__init__.py index 8b23de88c..8c133ca59 100644 --- a/scrapy/http/response/__init__.py +++ b/scrapy/http/response/__init__.py @@ -2,7 +2,7 @@ This module implements the Response class which is used to represent HTTP responses in Scrapy. -See documentation in docs/ref/request-response.rst +See documentation in docs/topics/request-response.rst """ import copy diff --git a/scrapy/http/response/html.py b/scrapy/http/response/html.py index 66e9124b5..6c7c43a10 100644 --- a/scrapy/http/response/html.py +++ b/scrapy/http/response/html.py @@ -2,7 +2,7 @@ This module implements the HtmlResponse class which adds encoding discovering through HTML encoding declarations to the TextResponse class. -See documentation in docs/ref/request-response.rst +See documentation in docs/topics/request-response.rst """ import re diff --git a/scrapy/http/response/text.py b/scrapy/http/response/text.py index 278da0b2d..0c726df37 100644 --- a/scrapy/http/response/text.py +++ b/scrapy/http/response/text.py @@ -2,7 +2,7 @@ This module implements the TextResponse class which adds encoding handling and discovering (through HTTP headers) to base Response class. -See documentation in docs/ref/request-response.rst +See documentation in docs/topics/request-response.rst """ import re diff --git a/scrapy/http/response/xml.py b/scrapy/http/response/xml.py index 760ad33b9..95c4a7e8c 100644 --- a/scrapy/http/response/xml.py +++ b/scrapy/http/response/xml.py @@ -2,7 +2,7 @@ This module implements the XmlResponse class which adds encoding discovering through XML encoding declarations to the TextResponse class. -See documentation in docs/ref/request-response.rst +See documentation in docs/topics/request-response.rst """ import re diff --git a/scrapy/link.py b/scrapy/link.py index 657fa541b..ddae07823 100644 --- a/scrapy/link.py +++ b/scrapy/link.py @@ -2,7 +2,7 @@ This module defines the Link object used in Link extractors. For actual link extractors implementation see scrapy.contrib.linkextractor, or -its documentation in: docs/ref/link-extractors.rst +its documentation in: docs/topics/link-extractors.rst """ class Link(object): diff --git a/scrapy/log.py b/scrapy/log.py index 384116ade..a93442d0a 100644 --- a/scrapy/log.py +++ b/scrapy/log.py @@ -1,7 +1,7 @@ """ Scrapy logging facility -See documentation in docs/ref/logging.rst +See documentation in docs/topics/logging.rst """ import sys from traceback import format_exc diff --git a/scrapy/mail.py b/scrapy/mail.py index eaf093eac..8275e75cb 100644 --- a/scrapy/mail.py +++ b/scrapy/mail.py @@ -1,7 +1,7 @@ """ Mail sending helpers -See documentation in docs/ref/email.rst +See documentation in docs/topics/email.rst """ from cStringIO import StringIO from email.MIMEMultipart import MIMEMultipart diff --git a/scrapy/selector/__init__.py b/scrapy/selector/__init__.py index 345b3dc51..f1028b639 100644 --- a/scrapy/selector/__init__.py +++ b/scrapy/selector/__init__.py @@ -1,7 +1,7 @@ """ XPath selectors -See documentation in docs/ref/selectors.rst +See documentation in docs/topics/selectors.rst """ import libxml2 diff --git a/scrapy/spider/models.py b/scrapy/spider/models.py index 33e3e6d83..a065f484f 100644 --- a/scrapy/spider/models.py +++ b/scrapy/spider/models.py @@ -1,7 +1,7 @@ """ Base class for Scrapy spiders -See documentation in docs/ref/spiders.rst +See documentation in docs/topics/spiders.rst """ from zope.interface import Interface, Attribute, invariant, implements from twisted.plugin import IPlugin