doc: added missing :synopsis: to some modules

This commit is contained in:
Pablo Hoffman 2009-08-29 03:46:58 -03:00
parent 2f55d7932b
commit c87216f02b
3 changed files with 13 additions and 3 deletions

View File

@ -1,6 +1,7 @@
.. _topics-images:
.. module:: scrapy.contrib.pipeline.images
:synopsis: Images Pipeline
===============
Handling Images
@ -175,8 +176,8 @@ BaseImagesPipeline
.. class:: BaseImagesPipeline
:class:`~scrapy.contrib.pipeline.MediaPipeline` descendant that implements
image downloading and thumbnail generation logic.
:class:`~scrapy.contrib.pipeline.media.MediaPipeline` descendant that
implements image downloading and thumbnail generation logic.
This pipeline tries to minimize network transfers and image processing,
doing stat of the images and determining if image is new, uptodate or
@ -233,7 +234,8 @@ BaseImagesPipeline
hash sign.
.. module:: scrapy.contrib.pipeline
.. module:: scrapy.contrib.pipeline.media
:synopsis: Media Pipeline
MediaPipeline
-------------

View File

@ -20,6 +20,7 @@ DuplicatesFilterMiddleware
--------------------------
.. module:: scrapy.contrib.schedulermiddleware.duplicatesfilter
:synopsis: Duplicates Filter Scheduler Middleware
.. class:: DuplicatesFilterMiddleware

View File

@ -122,6 +122,7 @@ DepthMiddleware
---------------
.. module:: scrapy.contrib.spidermiddleware.depth
:synopsis: Depth Spider Middleware
.. class:: DepthMiddleware
@ -140,6 +141,7 @@ HttpErrorMiddleware
-------------------
.. module:: scrapy.contrib.spidermiddleware.httperror
:synopsis: HTTP Error Spider Middleware
.. class:: HttpErrorMiddleware
@ -173,6 +175,7 @@ OffsiteMiddleware
-----------------
.. module:: scrapy.contrib.spidermiddleware.offsite
:synopsis: Offiste Spider Middleware
.. class:: OffsiteMiddleware
@ -188,6 +191,7 @@ RequestLimitMiddleware
----------------------
.. module:: scrapy.contrib.spidermiddleware.requestlimit
:synopsis: Request limit Spider Middleware
.. class:: RequestLimitMiddleware
@ -206,6 +210,7 @@ RestrictMiddleware
------------------
.. module:: scrapy.contrib.spidermiddleware.restrict
:synopsis: Restrict Spider Middleware
.. class:: RestrictMiddleware
@ -220,6 +225,7 @@ UrlFilterMiddleware
-------------------
.. module:: scrapy.contrib.spidermiddleware.urlfilter
:synopsis: URL Filter Spider Middleware
.. class:: UrlFilterMiddleware
@ -229,6 +235,7 @@ UrlLengthMiddleware
-------------------
.. module:: scrapy.contrib.spidermiddleware.urllength
:synopsis: URL Length Spider Middleware
.. class:: UrlLengthMiddleware