File: configuration-values.rst

package info (click to toggle)
sphinx-sitemap 2.6.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 300 kB
  • sloc: python: 368; makefile: 13
file content (36 lines) | stat: -rw-r--r-- 909 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
Project Configuration Values
============================

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

.. confval:: sitemap_url_scheme

   The scheme used for URL structure. Default is ``{lang}{version}{link}``.

   See :ref:`configuration_customizing_url_scheme` for more information.

   .. versionadded:: 2.0.0

.. confval:: sitemap_filename

   The filename used for the the sitemap. Default is ``sitemap.xml``.

   See :ref:`configuration_changing_filename` for more information.

   .. versionadded:: 2.2.0

.. confval:: sitemap_locales

   The list of locales to include in the sitemap.

   See :ref:`configuration_supporting_multiple_languages` for more information.

   .. versionadded:: 2.2.0

.. confval:: sitemap_excludes

   The list of pages to exclude from the sitemap.

   See :ref:`configuration_excluding_pages` for more information.

   .. versionadded:: 2.6.0