Skip to main content

Sitemap generator for Sphinx

Project description

# Sphinx Sitemap Generator Extension

[Sphinx](http://sphinx-doc.org/) extension to silently generate a sitemaps.org compliant sitemap for the HTML version of your Sphinx Documentation.

[![Build Status](https://travis-ci.org/jdillard/sphinx-sitemap.svg?branch=master)](https://travis-ci.org/jdillard/sphinx-sitemap)

## Installing

  1. Add/set the value of base_url in your Sphinx conf.py to the current base URL of your documentation. For example, https://my-site.com/docs/.
  2. Copy the sphinx_sitemap directory into your extensions directory or sys.path, then add sphinx_sitemap to the extensions array in your Sphinx conf.py.

> Note: sphinx-sitemap supports Sphinx 1.2 and later, and Python 2.7, 3.3, and 3.4.

## License

sphinx-sitemap is made available under a MIT license; see LICENSE for details.

Originally based on the sitemap generator in the [guzzle_sphinx_theme](https://github.com/guzzle/guzzle_sphinx_theme) project licensed under the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinx-sitemap, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size sphinx-sitemap-0.1.tar.gz (2.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page