Skip to main content

Sitemap generator for Sphinx

Project description

`Sphinx <http://sphinx-doc.org/>`__ extension to silently generate a sitemaps.org compliant sitemap for the HTML version of your Sphinx Documentation.

Build Status

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 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.

Source Distribution

sphinx-sitemap-0.2.tar.gz (2.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page