Skip to content

Commit fd065b6

Browse files
committed
Improve lastmod docs
1 parent 118a17c commit fd065b6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/source/advanced-configuration.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,10 +141,9 @@ To exclude a set of pages, add each page's path to ``sitemap_exclude``:
141141
142142
.. _configuration_lastmod:
143143

144-
Configuring Last Modified Timestamps
145-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
144+
Adding Last Modified Timestamps
145+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
146146

147-
By default, the sitemap does not include ``<lastmod>`` elements.
148147
To enable last modified timestamps in your sitemap, set :confval:`sitemap_show_lastmod` to ``True`` in **conf.py**:
149148

150149
.. code-block:: python
@@ -161,10 +160,11 @@ This produces sitemap entries like:
161160
<lastmod>2024-01-15T10:30:00+00:00</lastmod>
162161
</url>
163162
164-
.. note::
163+
.. important::
165164

166165
This feature requires Git to be available and your documentation to be in a Git repository.
167166
If Git is not available or the file is not tracked, no ``<lastmod>`` element will be added for that page.
167+
Shallow clones, which is the default for GitHub Actions, are not supported at this time.
168168

169169
.. 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.
170170

0 commit comments

Comments
 (0)