Tools used by OpenStack Documentation
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Christian Berendt 31c25891c1 script to generate the sitemap.xml for docs.openstack.org 6 years ago
..
generator script to generate the sitemap.xml for docs.openstack.org 6 years ago
README.md script to generate the sitemap.xml for docs.openstack.org 6 years ago
scrapy.cfg script to generate the sitemap.xml for docs.openstack.org 6 years ago
transform-sitemap.xslt Updates sitemap.xml for havana release links 6 years ago

README.md

= 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

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.

$ scrapy crawl sitemap

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.

$ scrapy crawl sitemap -a domain=developer.openstack.org

To write log messages into a file append the parameter -s LOG_FILE=scrapy.log.

== Dependencies

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