summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas Guettler <guettliml@thomas-guettler.de>2021-06-28 15:01:26 +0200
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2021-06-30 20:54:56 +0200
commitaaef4111ac880b530ce85557dc614f581ae8f3a9 (patch)
tree606f70a75eb50244a99f6ffa4c8e45ecc852bb8c
parent04b744050f1743a88e2bf0ca2ca82b34e3361f50 (diff)
[3.2.x] Fixed #32850 -- Doc'd Sitemap.paginator.
Backport of 775f7506d7fbabf79d8bdec4ccf039ce2870fe70 from main
-rw-r--r--docs/ref/contrib/sitemaps.txt9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/ref/contrib/sitemaps.txt b/docs/ref/contrib/sitemaps.txt
index 43ad1212d9..b9a558d895 100644
--- a/docs/ref/contrib/sitemaps.txt
+++ b/docs/ref/contrib/sitemaps.txt
@@ -186,6 +186,15 @@ Note:
Django respond appropriately to requests with an ``If-Modified-Since``
header which will prevent sending the sitemap if it hasn't changed.
+ .. attribute:: Sitemap.paginator
+
+ **Optional.**
+
+ This property returns a :class:`~django.core.paginator.Paginator` for
+ :attr:`~Sitemap.items()`. If you generate sitemaps in a batch you may
+ want to override this as a cached property in order to avoid multiple
+ ``items()`` calls.
+
.. attribute:: Sitemap.changefreq
**Optional.** Either a method or attribute.