Project Configuration Values

A list of of possible configuration values to configure in conf.py:

sitemap_url_scheme

  • Type: string

  • Default: '{lang}{version}{link}'

  • Description: The scheme used for URL structure. See Customizing the URL Scheme for more information.

Added in version 2.0.0.

sitemap_filename

  • Type: string

  • Default: 'sitemap.xml'

  • Description: The filename used for the sitemap. See Changing the Filename for more information.

Added in version 2.2.0.

sitemap_locales

  • Type: list of strings

  • Default: [] (empty list)

  • Description: The list of locales to include in the sitemap. See Language Support for more information.

Added in version 2.2.0.

sitemap_excludes

  • Type: list of strings

  • Default: [] (empty list)

  • Description: The list of pages to exclude from the sitemap. Supports wildcard patterns. See Excluding Pages for more information.

Added in version 2.6.0.

Changed in version 2.8.0: Added support for Unix-style wildcard patterns.

sitemap_show_lastmod

  • Type: boolean

  • Default: False

  • Description: Add <lastmod> to sitemap based on last updated time according to Git for each page. See Adding Last Modified Timestamps for more information.

Added in version 2.7.0.

sitemap_indent

  • Type: integer

  • Default: 0

  • Description: Number of spaces to use for indentation in the sitemap XML output. See Formatting XML Output for more information.

Added in version 2.9.0.