mirror of https://github.com/scrapy/scrapy.git
921fc4f3bf
This is to avoid accessing the scrapy.spider.spiders singleton for "resolving" spiders, which is considered an "evil" practice because it ties us to the singleton model for the spider resolver, which is a bad thing. This change will also work as the foundation for the API cleaning that we'll perform for 0.8. We decided to introduce this change now to have a more common basecode between 0.7 and 0.8, which will allow us to better support 0.7 until 0.8 is released. However, this change doesn't modify the stable/documented API, nor does it change the core logic. Those changes will land on the 0.8 branch, after 0.7 is released. --HG-- rename : scrapy/contrib/domainsch.py => scrapy/contrib/spiderscheduler.py |
||
|---|---|---|
| .. | ||
| _ext | ||
| _static | ||
| experimental | ||
| intro | ||
| media | ||
| topics | ||
| Makefile | ||
| README | ||
| api-stability.rst | ||
| conf.py | ||
| faq.rst | ||
| index.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.