Simplified sitemap_lastmod option

docs/source/advanced-configuration.rst

@@ -144,14 +144,15 @@ To exclude a set of pages, add each page's path to ``sitemap_exclude``:
 Adding Last Modification Date
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-To add the date of the last page modification set ``sitemap_lastmod`` to either ``True``, or a string representing
-the last modification date.
+To add the date of the last page modification set ``sitemap_lastmod`` a string
+representing the last modification date.
 
 .. code-block:: python
 
-   sitemap_lastmod = True
-   # or
    sitemap_lastmod = "2024-08-13"
+   # or
+   import datetime
+   sitemap_lastmod = f"{datetime.datetime.now():%Y-%m-%d}"
 
 .. _sitemapindex.xml: https://support.google.com/webmasters/answer/75712?hl=en
 .. _sitemaps.org: https://www.sitemaps.org/protocol.html

docs/source/conf.py

@@ -11,6 +11,7 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
+import datetime
 import re
 import subprocess
 
@@ -121,6 +122,8 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = "SphinxSitemapdoc"
 
+# Set last modification date in sitemap
+sitemap_lastmod = f"{datetime.datetime.now():%Y-%m-%d}"
 
 # -- Options for LaTeX output ------------------------------------------------
 

sphinx_sitemap/__init__.py

@@ -11,7 +11,6 @@
 # The above copyright notice and this permission notice shall be included in
 # all copies or substantial portions of the Software.
 
-import datetime
 import os
 import queue
 from multiprocessing import Manager
@@ -45,7 +44,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:
 
     app.add_config_value("sitemap_excludes", default=[], rebuild="")
 
-    app.add_config_value("sitemap_lastmod", default=None, rebuild="", types=[str, bool])
+    app.add_config_value("sitemap_lastmod", default=None, rebuild="", types=[str])
 
     try:
         app.add_config_value("html_baseurl", default=None, rebuild="")
@@ -190,8 +189,6 @@ def create_sitemap(app: Sphinx, exception):
     else:
         version = ""
 
-    date = f"{datetime.datetime.now():%Y-%m-%d}"
-
     while True:
         try:
             link = app.env.app.sitemap_links.get_nowait()  # type: ignore
@@ -208,13 +205,10 @@ def create_sitemap(app: Sphinx, exception):
         ElementTree.SubElement(url, "loc").text = site_url + scheme.format(
             lang=lang, version=version, link=link
         )
-        if app.builder.config.sitemap_lastmod:
-            if isinstance(app.builder.config.sitemap_lastmod, str):
-                ElementTree.SubElement(url, "lastmod").text = (
-                    app.builder.config.sitemap_lastmod
-                )
-            else:
-                ElementTree.SubElement(url, "lastmod").text = date
+        if app.builder.config.sitemap_lastmod is not None:
+            ElementTree.SubElement(url, "lastmod").text = (
+                app.builder.config.sitemap_lastmod
+            )
 
         for lang in locales:
             lang = lang + "/"

tests/test_simple.py

@@ -81,7 +81,7 @@ def test_html_file_suffix(app, status, warning):
     confoverrides={
         "html_baseurl": "https://example.org/docs/",
         "language": "en",
-        "sitemap_lastmod": True,
+        "sitemap_lastmod": "XX",
     },
 )
 def test_simple_dirhtml(app, status, warning):