Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tag: 0.15.0

Fetching latest commit…

Cannot retrieve the latest commit at this time

..
Failed to load latest commit information.
_ext
_static
experimental
intro
topics
Makefile
README
conf.py
contributing.rst
faq.rst
index.rst
versioning.rst

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.


Something went wrong with that request. Please try again.