scrapy/docs
Mikhail Korobov a11bd3e89d DOC update docs readme file - sphinx >= 1.3 is now required. 2015-04-15 11:50:57 +05:00
..
_ext
…
_static DOC remove css file which isno longer needed 2015-04-15 03:44:49 +05:00
experimental
…
intro
…
topics
…
utils
…
Makefile
…
README DOC update docs readme file - sphinx >= 1.3 is now required. 2015-04-15 11:50:57 +05:00
conf.py DOC make local docs use the same theme as readthedocs.org 2015-04-15 03:43:30 +05:00
contributing.rst
…
faq.rst
…
index.rst
…
news.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 Sphinx Python library. To install it
and all its dependencies run

::

    pip install 'Sphinx >= 1.3'


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.