History

Ammar Najjar da8cd9448d docs: always surround __init__ with `` in docs Issue #4086		2019-10-21 19:56:58 +02:00
..
_ext	fix docs building with recent sphinx: don't use deprecated sphinx options and imports	2018-02-13 19:47:41 +05:00
_static	DOC remove css file which isno longer needed	2015-04-15 03:44:49 +05:00
_templates	Add Segment Analytics to Documentation	2016-09-02 14:51:07 -03:00
intro	Fix internal links in the tutorial and release notes	2019-10-02 14:51:06 +02:00
topics	docs: always surround __init__ with `` in docs	2019-10-21 19:56:58 +02:00
utils	ur'string' not needed in Py 2, syntax error in Py3	2017-09-01 11:56:09 +02:00
Makefile	Add a Sphinx extension to generate documentation coverage information	2019-06-04 15:03:25 +02:00
README.rst	Clarify docs readme	2017-03-20 22:36:09 +05:30
conf.py	docs: use __init__ method instead of constructor	2019-10-21 15:42:24 +02:00
contributing.rst	Write the 1.7 release notes and cover dropping Python 2 support in the upcoming 2.0	2019-07-18 15:37:17 +02:00
faq.rst	[MRG+1] Drop py34 support - Update CI envs (#3892 )	2019-08-07 12:36:52 +05:00
index.rst	Document how to select dynamically-loaded content	2019-06-24 16:06:21 +02:00
news.rst	docs: use __init__ method instead of constructor	2019-10-21 15:42:24 +02:00
requirements.txt	Add a Sphinx extension to generate documentation coverage information	2019-06-04 15:03:25 +02:00
versioning.rst	backwards → backward (adj.)	2019-03-01 16:10:23 +01:00

orphan:

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 the following command from this dir

pip install -r requirements.txt

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.

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.

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.

There is a way to recreate the doc automatically when you make changes, you need to install watchdog (pip install watchdog) and then use:

make watch

</html>