diff --git a/docs/topics/extensions.rst b/docs/topics/extensions.rst index 084a128c7..db8d7ad27 100644 --- a/docs/topics/extensions.rst +++ b/docs/topics/extensions.rst @@ -212,8 +212,8 @@ The web server is designed to be extended by other extensions which can add their own management web interfaces. See also :ref:`topics-webconsole` for information on how to write your own web -console extension, and "Web console extensions" below for a list of available -built-in (web console) extensions. +console extension, and :ref:`topics-webconsole-extensions-ref` for a list of +available built-in (web console) extensions. .. _topics-extensions-ref-telnetconsole: @@ -327,69 +327,6 @@ domain has finished scraping, including the Scrapy stats collected. The email will be sent to all recipients specified in the :setting:`STATSMAILER_RCPTS` setting. - -Web console extensions ----------------------- - -.. module:: scrapy.contrib.webconsole - :synopsis: Contains most built-in web console extensions - -Here is a list of built-in web console extensions. For clarity "web console -extension" is abbreviated as "WC extension". - -For more information see the see the :ref:`web console documentation -`. - -Scheduler queue WC extension -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. module:: scrapy.contrib.webconsole.scheduler - :synopsis: Scheduler queue web console extension - -.. class:: scrapy.contrib.webconsole.scheduler.SchedulerQueue - -Display a list of all pending Requests in the Scheduler queue, grouped by -domain/spider. - -Spider live stats WC extension -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. module:: scrapy.contrib.webconsole.livestats - :synopsis: Spider live stats web console extension - -.. class:: scrapy.contrib.webconsole.livestats.LiveStats - -Display a table with stats of all spider crawled by the current Scrapy run, -including: - -* Number of items scraped -* Number of pages crawled -* Number of pending requests in the scheduler -* Number of pending requests in the downloader queue -* Number of requests currently being downloaded - -Engine status WC extension -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. module:: scrapy.contrib.webconsole.enginestatus - :synopsis: Engine status web console extension - -.. class:: scrapy.contrib.webconsole.enginestatus.EngineStatus - -Display the current status of the Scrapy Engine, which is just the output of -the Scrapy engine ``getstatus()`` method. - -Stats collector dump WC extension -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. module:: scrapy.contrib.webconsole.stats - :synopsis: Stats dump web console extension - -.. class:: scrapy.contrib.webconsole.stats.StatsDump - -Display the stats collected so far by the stats collector. - - .. module:: scrapy.contrib.debug :synopsis: Extensions for debugging Scrapy diff --git a/docs/topics/webconsole.rst b/docs/topics/webconsole.rst index 71037c376..fd23e4dd7 100644 --- a/docs/topics/webconsole.rst +++ b/docs/topics/webconsole.rst @@ -82,3 +82,61 @@ you access the URL: You will see a page containing a big "Hello World!" text. +.. _topics-webconsole-extensions-ref: + +Available Web console extensions +-------------------------------- + +.. module:: scrapy.contrib.webconsole + :synopsis: Contains most built-in web console extensions + +Here is a list of built-in web console extensions. + +Scheduler queue extension +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. module:: scrapy.contrib.webconsole.scheduler + :synopsis: Scheduler queue web console extension + +.. class:: scrapy.contrib.webconsole.scheduler.SchedulerQueue + +Display a list of all pending Requests in the Scheduler queue, grouped by +domain/spider. + +Spider live stats extension +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. module:: scrapy.contrib.webconsole.livestats + :synopsis: Spider live stats web console extension + +.. class:: scrapy.contrib.webconsole.livestats.LiveStats + +Display a table with stats of all spider crawled by the current Scrapy run, +including: + +* Number of items scraped +* Number of pages crawled +* Number of pending requests in the scheduler +* Number of pending requests in the downloader queue +* Number of requests currently being downloaded + +Engine status extension +~~~~~~~~~~~~~~~~~~~~~~~ + +.. module:: scrapy.contrib.webconsole.enginestatus + :synopsis: Engine status web console extension + +.. class:: scrapy.contrib.webconsole.enginestatus.EngineStatus + +Display the current status of the Scrapy Engine, which is just the output of +the Scrapy engine ``getstatus()`` method. + +Stats collector dump extension +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. module:: scrapy.contrib.webconsole.stats + :synopsis: Stats dump web console extension + +.. class:: scrapy.contrib.webconsole.stats.StatsDump + +Display the stats collected so far by the stats collector.