From 137429e5188329cd23ffcd88b4ef0ba26b982ee5 Mon Sep 17 00:00:00 2001 From: Pablo Hoffman Date: Sat, 3 Jan 2009 07:54:33 +0000 Subject: [PATCH] doc: added README --HG-- extra : convert_revision : svn%3Ab85faa78-f9eb-468e-a121-7cced6da292c%40634 --- scrapy/trunk/docs/README | 54 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 scrapy/trunk/docs/README diff --git a/scrapy/trunk/docs/README b/scrapy/trunk/docs/README new file mode 100644 index 000000000..7fd549374 --- /dev/null +++ b/scrapy/trunk/docs/README @@ -0,0 +1,54 @@ +====================================== +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. + +