Browse Source

[sitemap] transform README from Markdown to reStructuredText

Change-Id: Icdd8269323075cb3b9a7f81d9118cf57b36a7267
tags/0.30.1
Christian Berendt 4 years ago
parent
commit
5b21d5f8e2
1 changed files with 14 additions and 17 deletions
  1. 14
    17
      sitemap/README.rst

sitemap/README.md → sitemap/README.rst View File

@@ -1,39 +1,36 @@
1
-= Sitemap Generator
1
+Sitemap Generator
2
+*****************
2 3
 
3 4
 This script crawls all available sites on http://docs.openstack.org and extracts
4 5
 all URLs. Based on the URLs the script generates a sitemap for search engines
5 6
 according to the protocol described at http://www.sitemaps.org/protocol.html.
6 7
 
7
-== Usage
8
+Usage
9
+=====
8 10
 
9 11
 To generate a new sitemap file simply run the spider using the
10 12
 following command. It will take several minutes to crawl all available sites
11 13
 on http://docs.openstack.org. The result will be available in the file
12
-```sitemap_docs.openstack.org.xml```.
14
+``sitemap_docs.openstack.org.xml``.
13 15
 
14
-```
15
-$ scrapy crawl sitemap
16
-```
16
+    $ scrapy crawl sitemap
17 17
 
18
-It's also possible to crawl other sites using the attribute ```domain```.
18
+It's also possible to crawl other sites using the attribute ``domain``.
19 19
 
20 20
 For example to crawl http://developer.openstack.org use the following command.
21
-The result will be available in the file ```sitemap_developer.openstack.org.xml```.
21
+The result will be available in the file ``sitemap_developer.openstack.org.xml``.
22 22
 
23
-```
24
-$ scrapy crawl sitemap -a domain=developer.openstack.org
25
-```
23
+    $ scrapy crawl sitemap -a domain=developer.openstack.org
26 24
 
27
-To write log messages into a file append the parameter ```-s LOG_FILE=scrapy.log```.
25
+To write log messages into a file append the parameter ``-s LOG_FILE=scrapy.log``.
28 26
 
29
-== Dependencies
27
+Dependencies
28
+============
30 29
 
31
-* Scrapy (https://pypi.python.org/pypi/Scrapy)
30
+* `Scrapy <https://pypi.python.org/pypi/Scrapy>`_
32 31
 
33 32
 To install the needed modules you can use pip or the package management system included
34 33
 in your distribution. When using the package management system maybe the name of the
35 34
 packages differ. When using pip it's maybe necessary to install some development packages.
36 35
 
37
-```
38
-$ pip install scrapy
39
-```
36
+    $ pip install scrapy

Loading…
Cancel
Save