sphinx-sitemap 1.1.0

Sitemap generator for Sphinx

A Sphinx extension to silently generate multiversion and multilanguage sitemaps.org compliant sitemaps for the HTML version of your Sphinx documentation.

Installing

Directly install via pip by using:

pip install sphinx-sitemap

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

extensions = ['sphinx_sitemap']

Set the value of html_baseurl in your Sphinx conf.py to the current base URL of your documentation with a trailing slash. For example:

html_baseurl = 'https://my-site.com/docs/'

Versioning Configuration

For multiversion sitemaps, you have to generate a sitemap per version and then manually add their locations to a sitemapindex file.

The extension will look at the version config value for the current version being built, so make sure that is set.

Note: When using multiple versions, it is best practice to set the canonical URL in the theme layout of all versions to the latest version of that page:

<link rel="canonical" href="https://my-site.com/docs/en/latest/index.html"/>

Multilingual Configuration

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

The extension will look at the language config value for the current language being built, and the locale_dirs value for the directory for alternate languages, so make sure those are set.

Note: The extension is currently opinionated, in that it will also use the version config value, if set, after the language value in the generated URL. Setting it to latest is appropriate for most use cases, but it can also be left blank.

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

<?xml version="1.0" encoding="utf-8"?>
<urlset xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <url>
    <loc>https://my-site.com/docs/en/latest/index.html</loc>
    <xhtml:link href="https://my-site.com/docs/es/latest/index.html" hreflang="es" rel="alternate"/>
    <xhtml:link href="https://my-site.com/docs/fr/latest/index.html" hreflang="fr" rel="alternate"/>
    <xhtml:link href="https://my-site.com/docs/en/latest/index.html" hreflang="en" rel="alternate"/>
  </url>
  <url>
    <loc>https://my-site.com/docs/en/latest/about.html</loc>
    <xhtml:link href="https://my-site.com/docs/es/latest/about.html" hreflang="es" rel="alternate"/>
    <xhtml:link href="https://my-site.com/docs/fr/latest/about.html" hreflang="fr" rel="alternate"/>
    <xhtml:link href="https://my-site.com/docs/en/latest/index.html" hreflang="en" rel="alternate"/>
  </url>
</urlset>

Getting the Most out of the Sitemap

1. Add a robots.txt file in the source directory which contains a link to the sitemap or sitemapindex. For example:

   User-agent: *
   
   Sitemap: https://my-site.com/docs/sitemap.xml

   Then, add robots.txt to the html_extra_path config value:

   html_extra_path = ['robots.txt']

2. Submit the sitemap or sitemapindex to the appropriate search engine tools.

See Who Is Using It

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

Contributing

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

Maintaining PyPI Version

These are the steps, to be run by the maintainer, for making a new Python package release.

1. Rev versions in sphinx_sitemap/version.py and setup.py.

2. Update CHANGELOG.md

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. Create latest distribution locally:

   python setup.py sdist

5. Upload to the test pypi.org repository:

   twine upload --repository-url https://test.pypi.org/legacy/ dist/*

6. Upload to the production pypi.org repository:

   twine upload dist/*

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, also licensed under the MIT license.