openstack
/
openstack-doc-tools
Code Issues Proposed changes

Merge "[sitemap] transform README from Markdown to reStructuredText"

This commit is contained in:
Jenkins 2015-08-22 13:23:53 +00:00 committed by Gerrit Code Review
parent 8a2df7b6ef 5b21d5f8e2
commit 89624681c1
1 changed files with 14 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,39 +1,36 @@
= Sitemap Generator
Sitemap Generator
*****************
This script crawls all available sites on http://docs.openstack.org and extracts
all URLs. Based on the URLs the script generates a sitemap for search engines
according to the protocol described at http://www.sitemaps.org/protocol.html.
== Usage
Usage
=====
To generate a new sitemap file simply run the spider using the
following command. It will take several minutes to crawl all available sites
on http://docs.openstack.org. The result will be available in the file
```sitemap_docs.openstack.org.xml```.
``sitemap_docs.openstack.org.xml``.
```
$ scrapy crawl sitemap
```
$ scrapy crawl sitemap
It's also possible to crawl other sites using the attribute ```domain```.
It's also possible to crawl other sites using the attribute ``domain``.
For example to crawl http://developer.openstack.org use the following command.
The result will be available in the file ```sitemap_developer.openstack.org.xml```.
The result will be available in the file ``sitemap_developer.openstack.org.xml``.
```
$ scrapy crawl sitemap -a domain=developer.openstack.org
```
$ scrapy crawl sitemap -a domain=developer.openstack.org
To write log messages into a file append the parameter ```-s LOG_FILE=scrapy.log```.
To write log messages into a file append the parameter ``-s LOG_FILE=scrapy.log``.
== Dependencies
Dependencies
============
* Scrapy (https://pypi.python.org/pypi/Scrapy)
* `Scrapy <https://pypi.python.org/pypi/Scrapy>`_
To install the needed modules you can use pip or the package management system included
in your distribution. When using the package management system maybe the name of the
packages differ. When using pip it's maybe necessary to install some development packages.
```
$ pip install scrapy
```
$ pip install scrapy