From 7f5117e33752d9519965a601cc25f8df791a4bca Mon Sep 17 00:00:00 2001 From: Ismael Carnales Date: Tue, 16 Dec 2008 14:58:52 +0000 Subject: [PATCH] reworking docs structure --HG-- extra : convert_revision : svn%3Ab85faa78-f9eb-468e-a121-7cced6da292c%40507 --- sites/scrapy.org/docs/sources/index.rst | 5 +- sites/scrapy.org/docs/sources/intro/index.rst | 8 ++++ .../scrapy.org/docs/sources/intro/install.rst | 46 +++++++++++++++++++ .../{scrapy_intro.rst => intro/overview.rst} | 0 .../{tutorial => tutorial_old}/index.rst | 0 .../{tutorial => tutorial_old}/tutorial1.rst | 0 .../{tutorial => tutorial_old}/tutorial2.rst | 0 .../{tutorial => tutorial_old}/tutorial3.rst | 0 8 files changed, 56 insertions(+), 3 deletions(-) create mode 100644 sites/scrapy.org/docs/sources/intro/index.rst create mode 100644 sites/scrapy.org/docs/sources/intro/install.rst rename sites/scrapy.org/docs/sources/{scrapy_intro.rst => intro/overview.rst} (100%) rename sites/scrapy.org/docs/sources/{tutorial => tutorial_old}/index.rst (100%) rename sites/scrapy.org/docs/sources/{tutorial => tutorial_old}/tutorial1.rst (100%) rename sites/scrapy.org/docs/sources/{tutorial => tutorial_old}/tutorial2.rst (100%) rename sites/scrapy.org/docs/sources/{tutorial => tutorial_old}/tutorial3.rst (100%) diff --git a/sites/scrapy.org/docs/sources/index.rst b/sites/scrapy.org/docs/sources/index.rst index a7ce9a7bf..16f52b14a 100644 --- a/sites/scrapy.org/docs/sources/index.rst +++ b/sites/scrapy.org/docs/sources/index.rst @@ -8,9 +8,8 @@ Scrapy's documentation Contents: .. toctree:: + :maxdepth: 2 - basics - scrapy_intro - tutorial/index + intro/index tutorial2/index reference/index diff --git a/sites/scrapy.org/docs/sources/intro/index.rst b/sites/scrapy.org/docs/sources/intro/index.rst new file mode 100644 index 000000000..09dc1b04d --- /dev/null +++ b/sites/scrapy.org/docs/sources/intro/index.rst @@ -0,0 +1,8 @@ +Introduction +============ + +.. toctree:: + :maxdepth: 1 + + overview + install diff --git a/sites/scrapy.org/docs/sources/intro/install.rst b/sites/scrapy.org/docs/sources/intro/install.rst new file mode 100644 index 000000000..2e95a8de9 --- /dev/null +++ b/sites/scrapy.org/docs/sources/intro/install.rst @@ -0,0 +1,46 @@ +.. _install: + +===================== +How to install Scrapy +===================== + +Requirements +============ + +* `Python `_ 2.5 or above +* `Twisted `_ +* `libxml2 `_ +* `pyopenssl `_ + +Optional: + +* `spidermonkey `_ +* `simplejson `_ + +Install Python +============== + +Scrapy works with Python 2.5 or above, you can get it at http://www.python.org. + +Install required libraries +========================== + +The procedure for installing the required third party libraries (twisted, libxml2 and pyopenssl) depends on the platform and OS you use. + +If you're running Ubuntu/Debian Linux do: + +.. code-block:: bash + + apt-get install python-twisted python-libxml2 python-pyopenssl + +Or in Arch Linux do: + +.. code-block:: bash + + pacman -S twisted python-lxml pyopenssl + + +Install Scrapy code +=================== + + diff --git a/sites/scrapy.org/docs/sources/scrapy_intro.rst b/sites/scrapy.org/docs/sources/intro/overview.rst similarity index 100% rename from sites/scrapy.org/docs/sources/scrapy_intro.rst rename to sites/scrapy.org/docs/sources/intro/overview.rst diff --git a/sites/scrapy.org/docs/sources/tutorial/index.rst b/sites/scrapy.org/docs/sources/tutorial_old/index.rst similarity index 100% rename from sites/scrapy.org/docs/sources/tutorial/index.rst rename to sites/scrapy.org/docs/sources/tutorial_old/index.rst diff --git a/sites/scrapy.org/docs/sources/tutorial/tutorial1.rst b/sites/scrapy.org/docs/sources/tutorial_old/tutorial1.rst similarity index 100% rename from sites/scrapy.org/docs/sources/tutorial/tutorial1.rst rename to sites/scrapy.org/docs/sources/tutorial_old/tutorial1.rst diff --git a/sites/scrapy.org/docs/sources/tutorial/tutorial2.rst b/sites/scrapy.org/docs/sources/tutorial_old/tutorial2.rst similarity index 100% rename from sites/scrapy.org/docs/sources/tutorial/tutorial2.rst rename to sites/scrapy.org/docs/sources/tutorial_old/tutorial2.rst diff --git a/sites/scrapy.org/docs/sources/tutorial/tutorial3.rst b/sites/scrapy.org/docs/sources/tutorial_old/tutorial3.rst similarity index 100% rename from sites/scrapy.org/docs/sources/tutorial/tutorial3.rst rename to sites/scrapy.org/docs/sources/tutorial_old/tutorial3.rst