🐛 FIX: Change sitemap_show_lastmod to default of False (#110)

Author: jdillard

CHANGELOG.rst

@@ -3,6 +3,13 @@
 Changelog
 =========
 
+2.7.2
+-----
+
+*Release date: 2025-06-26*
+
+- Change ``sitemap_show_lastmod`` to default of ``False``
+
 2.7.1
 -----
 

docs/source/advanced-configuration.rst

@@ -139,6 +139,35 @@ To exclude a set of pages, add each page's path to ``sitemap_exclude``:
        "genindex.html",
    ]
 
+.. _configuration_lastmod:
+
+Configuring Last Modified Timestamps
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+By default, the sitemap does not include ``<lastmod>`` elements.
+To enable last modified timestamps in your sitemap, set :confval:`sitemap_show_lastmod` to ``True`` in **conf.py**:
+
+.. code-block:: python
+
+   sitemap_show_lastmod = True
+
+When enabled, the extension uses Git to determine the last modified date for each page based on the most recent commit that modified the source file.
+This produces sitemap entries like:
+
+.. code-block:: xml
+
+   <url>
+     <loc>https://my-site.com/docs/en/index.html</loc>
+     <lastmod>2024-01-15T10:30:00+00:00</lastmod>
+   </url>
+
+.. note::
+
+   This feature requires Git to be available and your documentation to be in a Git repository.
+   If Git is not available or the file is not tracked, no ``<lastmod>`` element will be added for that page.
+
+.. tip:: The ``<lastmod>`` timestamps are particularly useful for :ref:`RAG (Retrieval-Augmented Generation) systems <rag-ingestion>` that need to identify recently updated content for incremental updates.
+
 
 .. _sitemapindex.xml: https://support.google.com/webmasters/answer/75712?hl=en
 .. _sitemaps.org: https://www.sitemaps.org/protocol.html

docs/source/conf.py

@@ -115,6 +115,7 @@
 
 html_baseurl = "https://sphinx-sitemap.readthedocs.org/"
 
+sitemap_show_lastmod = True
 
 # -- Options for HTMLHelp output ---------------------------------------------
 

docs/source/configuration-values.rst

@@ -5,38 +5,45 @@ 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.
+   - **Type**: string
+   - **Default**: ``'{lang}{version}{link}'``
+   - **Description**: The scheme used for URL structure.
+     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.
+   - **Type**: string
+   - **Default**: ``'sitemap.xml'``
+   - **Description**: The filename used for the sitemap.
+     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.
+   - **Type**: list of strings
+   - **Default**: ``[]`` (empty list)
+   - **Description**: 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.
+   - **Type**: list of strings
+   - **Default**: ``[]`` (empty list)
+   - **Description**: The list of pages to exclude from the sitemap.
+     See :ref:`configuration_excluding_pages` for more information.
 
    .. versionadded:: 2.6.0
 
 .. confval:: sitemap_show_lastmod
 
-   Add ``<lastmod>`` to sitemap based on last updated time according to Git for each page.
+   - **Type**: boolean
+   - **Default**: ``False``
+   - **Description**: Add ``<lastmod>`` to sitemap based on last updated time according to Git for each page.
+     See :ref:`configuration_lastmod` for more information.
 
    .. versionadded:: 2.7.0

docs/source/search-optimization.rst

@@ -35,6 +35,8 @@ Examples:
 
 .. _Algolia: https://www.algolia.com/doc/tools/crawler/apis/configuration/sitemaps/
 
+.. _rag-ingestion:
+
 RAG (Retrieval-Augmented Generation) Ingestion
 -----------------------------------------------
 

pyproject.toml

@@ -24,8 +24,6 @@ license = "MIT"
 license-files = ["LICENSE"]
 readme = "README.rst"
 dependencies = [
-    "requests>=2.28.1",
-    "flask>=2.0.0",
     "sphinx-last-updated-by-git",
 ]
 dynamic = [

sphinx_sitemap/__init__.py

@@ -23,7 +23,7 @@
 from sphinx.errors import ExtensionError
 from sphinx.util.logging import getLogger
 
-__version__ = "2.7.1"
+__version__ = "2.7.2"
 
 logger = getLogger(__name__)
 
@@ -40,13 +40,13 @@ def setup(app: Sphinx) -> Dict[str, Any]:
     app.add_config_value(
         "sitemap_url_scheme", default="{lang}{version}{link}", rebuild=""
     )
-    app.add_config_value("sitemap_locales", default=None, rebuild="")
+    app.add_config_value("sitemap_locales", default=[], rebuild="")
 
     app.add_config_value("sitemap_filename", default="sitemap.xml", rebuild="")
 
     app.add_config_value("sitemap_excludes", default=[], rebuild="")
 
-    app.add_config_value("sitemap_show_lastmod", default=True, rebuild="")
+    app.add_config_value("sitemap_show_lastmod", default=False, rebuild="")
 
     try:
         app.add_config_value("html_baseurl", default=None, rebuild="")