scrapy/docs
Capi Etheriel bc17e9d412 Adds HtmlCSSSelector and XmlCSSSelector classes, cssselect as optional dependency.
Ported .get() from _Element and .text_content() from HTMLMixin

Add CSS selectors to scrapy shell

Documenting CSS Selectors: Constructing selectors

Documenting CSS Selectors: Using Selectors

Make CSS Selectors a default feature.

Adds XPath powers to CSS Selectors and some syntactic sugar.

Removes methods copied over from lxml.html.HtmlMixin.

Updating docs to use new CSS Selector super powers.

Documenting CSS Selectors: Regular Expressions

Moving section after Nesting section, since it mentions it.

Documenting CSS Selectors: Nesting Selectors

Fix XPath specificity in lxml.selector.CSSSelectorMixin.text

Cleaning up unused stuff from cssel.py

Changing the behavior of lxml.selector.CSSSelectorMixin.text.

Concatenating all of the descendant text nodes is more useful
than returning it in pieces (there's xpath() if you need that).

Documenting CSS Selectors: CSS Selector objects

Documenting CSS Selectors: CSSSelectorList objects

Documenting CSS Selectors: HtmlCSSSelector objects

Documenting CSS Selectors: XmlCSSSelector objects

Fixing some documentations typos and errors

Enforcing the 80-char width lines

Tidying up CSS selectors and CSSSelectorMixin objects

Adding some missing references in documentation.

Fixing lxml.selector.CSSSelectorList.text
2013-10-10 18:23:15 -02:00
..
_ext added issue role to documentation 2012-08-31 18:39:30 -03:00
_static removed documentation header notifying about other documentation versions, as that's provided by readthedocs already 2011-09-14 02:39:32 -03:00
experimental added documentation (experimental feature) 2013-03-06 06:36:23 +11:00
intro fix doc typo 2013-10-09 17:24:12 -02:00
topics Adds HtmlCSSSelector and XmlCSSSelector classes, cssselect as optional dependency. 2013-10-10 18:23:15 -02:00
Makefile Removed unneeded code (since autodoc is not used in Sphinx doc) 2010-09-22 10:52:02 -03:00
README mv scrapy/trunk to root as part of svn2hg migration 2009-05-06 15:55:17 -03:00
conf.py update copyright notes 2013-05-16 15:05:52 -03:00
contributing.rst minor updates to contributing doc 2013-03-13 03:24:25 -03:00
faq.rst fixed typo to parallel fix on 0.16 branch 2013-08-03 17:06:10 -07:00
index.rst add scrapy bench command for benchmarking, with documentation 2013-05-16 13:15:25 -03:00
news.rst Add 0.18.4 release notes 2013-10-10 01:04:35 -02:00
versioning.rst updated versioning doc according to recent changes 2012-01-05 11:50:28 -02: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.