scrapy/docs
Pablo Hoffman 86498abdf1 Sorted out Link Extractors organization by moving all them to
scrapy.contrib.linkextractors.

The most relevant being:
    scrapy.link.extractors.RegexLinkExtractor

which was moved to:
    scrapy.contrib.linkextractors.sgml.SgmlLinkExtractor

The old location still works but throws a deprecation warning. It will be
removed before the 0.7 release.

Documentation and tests were also updated.

Also, in this changeset, a new regex-based link extractor was added to
scrapy.contrib.linkextractors.regex.

--HG--
rename : scrapy/tests/sample_data/link_extractor/regex_linkextractor.html => scrapy/tests/sample_data/link_extractor/sgml_linkextractor.html
rename : scrapy/tests/test_link.py => scrapy/tests/test_contrib_linkextractors.py
2009-05-18 19:19:37 -03:00
..
_ext mv scrapy/trunk to root as part of svn2hg migration 2009-05-06 15:55:17 -03:00
_static mv scrapy/trunk to root as part of svn2hg migration 2009-05-06 15:55:17 -03:00
intro Sorted out Link Extractors organization by moving all them to 2009-05-18 19:19:37 -03:00
media mv scrapy/trunk to root as part of svn2hg migration 2009-05-06 15:55:17 -03:00
misc mv scrapy/trunk to root as part of svn2hg migration 2009-05-06 15:55:17 -03:00
proposed Sorted out Link Extractors organization by moving all them to 2009-05-18 19:19:37 -03:00
ref Sorted out Link Extractors organization by moving all them to 2009-05-18 19:19:37 -03:00
topics Sorted out Link Extractors organization by moving all them to 2009-05-18 19:19:37 -03:00
Makefile mv scrapy/trunk to root as part of svn2hg migration 2009-05-06 15:55:17 -03:00
README mv scrapy/trunk to root as part of svn2hg migration 2009-05-06 15:55:17 -03:00
conf.py mv scrapy/trunk to root as part of svn2hg migration 2009-05-06 15:55:17 -03:00
faq.rst mv scrapy/trunk to root as part of svn2hg migration 2009-05-06 15:55:17 -03:00
index.rst mv scrapy/trunk to root as part of svn2hg migration 2009-05-06 15:55:17 -03:00

README

======================================
Scrapy documentation quick start guide
======================================

This file provides a quick guide on how to compile the Scrapy documentation.


Setup the environment
---------------------

To compile the documentation you need the following Python libraries:

 * Sphinx
 * docutils
 * jinja

If you have setuptools available the following command will install all of them
(since Sphinx requires both docutils and jinja)::

    easy_install Sphinx


Compile the documentation
-------------------------

To compile the documentation (to classic HTML output) run the following command
from this dir::

    make html

Documentation will be generated (in HTML format) inside the ``build/html`` dir.


View the documentation
----------------------

To view the documentation run the following command::

    make htmlview

This command will fire up your default browser and open the main page of your
(previously generated) HTML documentation.


Start over
----------

To cleanup all generated documentation files and start from scratch run::

    make clean

Keep in mind that this command won't touch any documentation source files.