mirror of https://github.com/scrapy/scrapy.git
updated some documentation references in source code
This commit is contained in:
parent
33b53c59d5
commit
06db0bc124
|
|
@ -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)
|
||||
|
||||
"""
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
"""
|
||||
MemoryDebugger extension
|
||||
|
||||
See documentation in docs/ref/extensions.rst
|
||||
See documentation in docs/topics/extensions.rst
|
||||
"""
|
||||
|
||||
import gc
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
"""
|
||||
MemoryUsage extension
|
||||
|
||||
See documentation in docs/ref/extensions.rst
|
||||
See documentation in docs/topics/extensions.rst
|
||||
"""
|
||||
|
||||
import os
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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):
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
"""
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
"""
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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):
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
"""
|
||||
XPath selectors
|
||||
|
||||
See documentation in docs/ref/selectors.rst
|
||||
See documentation in docs/topics/selectors.rst
|
||||
"""
|
||||
|
||||
import libxml2
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Reference in New Issue