Browse Source

Improve the README file of the sitemap generator

Change-Id: I4143b4dc7846b4dcdb873921a0ee75a62cc8f8ef
tags/1.2.1
Christian Berendt 2 years ago
parent
commit
8a8411e3ff
1 changed files with 18 additions and 12 deletions
  1. 18
    12
      sitemap/README.rst

+ 18
- 12
sitemap/README.rst View File

@@ -1,10 +1,27 @@
1
+=================
1 2
 Sitemap Generator
2
-*****************
3
+=================
3 4
 
4 5
 This script crawls all available sites on http://docs.openstack.org and extracts
5 6
 all URLs. Based on the URLs the script generates a sitemap for search engines
6 7
 according to the protocol described at http://www.sitemaps.org/protocol.html.
7 8
 
9
+Installation
10
+============
11
+
12
+To install the needed modules you can use pip or the package management system included
13
+in your distribution. When using the package management system maybe the name of the
14
+packages differ. Installation in a virtual environment is recommended.
15
+
16
+    $ virtualenv venv
17
+    $ source venv/bin/activate
18
+    $ pip install -r requirements.txt
19
+
20
+When using pip it's maybe necessary to install some development packages.
21
+For example on Ubuntu 16.04 install the following packages.
22
+
23
+    $ sudo apt install gcc libssl-dev python-dev python-virtualenv
24
+
8 25
 Usage
9 26
 =====
10 27
 
@@ -28,14 +45,3 @@ It is possible to define a set of additional start URLs using the attribute
28 45
 ``urls``. Separate multiple URLs with ``,``.
29 46
 
30 47
     $ scrapy crawl sitemap -a domain=developer.openstack.org -a urls="http://developer.openstack.org/de/api-guide/quick-start/"
31
-
32
-Dependencies
33
-============
34
-
35
-* `Scrapy <https://pypi.python.org/pypi/Scrapy>`_
36
-
37
-To install the needed modules you can use pip or the package management system included
38
-in your distribution. When using the package management system maybe the name of the
39
-packages differ. When using pip it's maybe necessary to install some development packages.
40
-
41
-    $ pip install -r requirements.txt

Loading…
Cancel
Save