Skip to main content

Sitemap generator for Sphinx

Project description

A Sphinx extension to silently generate a compliant sitemap for the HTML version of your Sphinx Documentation.

Build Status PyPI version License: MIT


Directly install via pip by using:

pip install sphinx-sitemap

Add sphinx_sitemap to the extensions array in your Sphinx For example:

extensions = ['sphinx_sitemap']

Set the value of html_baseurl in your Sphinx to the current base URL of your documentation. For example:

html_baseurl = ''

Note: html_baseurl was introduced in Sphinx 1.8.0. If you are using a version prior to that you must set your base URL to site_url instead.

For multilingual sitemaps, you have to generate a sitemap per language/locale and then manually add them to a sitemapindex file.

The extension will look at the language config value for the current language being built, and locale_dirs for the directory of alternate languages.

Note: It is currently opinionated, in that it will also use the version config value in the generated URL.

The end result is something like the following for each language/version build:

<?xml version="1.0" encoding="utf-8"?>
<urlset xmlns:xhtml="" xmlns="">
    <xhtml:link href="" hreflang="es" rel="alternate"/>
    <xhtml:link href="" hreflang="fr" rel="alternate"/>
    <xhtml:link href="" hreflang="en" rel="alternate"/>
    <xhtml:link href="" hreflang="es" rel="alternate"/>
    <xhtml:link href="" hreflang="fr" rel="alternate"/>
    <xhtml:link href="" hreflang="en" rel="alternate"/>

See Who Is Using It

You can use GitHub search to see who is using sphinx-sitemap.


Pull Requests welcome! See CONTRIBUTING for instructions on how best to contribute.

Maintaining PyPI Version

These are the steps for making a new Python package release.

  1. Rev versions in sphinx_sitemap/ and

  2. Update

  3. Create a tag and push to GitHub:

    git tag -a vX.Y.Z -m "Release vX.Y.Z"
    git push --tags origin master
  4. Upload the latest distribution:

    python sdist upload -r pypi


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, also 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 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size sphinx-sitemap-1.0.1.tar.gz (4.2 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