diff options
| author | Arkadiusz Adamski <arkadiusz.adamski@gmail.com> | 2021-10-21 16:09:29 +0200 |
|---|---|---|
| committer | Carlton Gibson <carlton.gibson@noumenal.es> | 2021-10-21 16:22:25 +0200 |
| commit | 1405dc78872f9d18180feebb4f2c57dbe1259acb (patch) | |
| tree | bed85feafa4b8e71f2d913d4de3a86e6254680ab /docs | |
| parent | 480191244d12fefbf95854b2b117c71ffe44749a (diff) | |
Fixed #33210 -- Clarified docs for sitemaps ping_google() helper.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/contrib/sitemaps.txt | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/docs/ref/contrib/sitemaps.txt b/docs/ref/contrib/sitemaps.txt index e6c96be21d..c985ddb81a 100644 --- a/docs/ref/contrib/sitemaps.txt +++ b/docs/ref/contrib/sitemaps.txt @@ -421,7 +421,8 @@ Here's what the relevant URLconf lines would look like for the example above:: from django.contrib.sitemaps import views urlpatterns = [ - path('sitemap.xml', views.index, {'sitemaps': sitemaps}), + path('sitemap.xml', views.index, {'sitemaps': sitemaps}, + name='django.contrib.sitemaps.views.index'), path('sitemap-<section>.xml', views.sitemap, {'sitemaps': sitemaps}, name='django.contrib.sitemaps.views.sitemap'), ] @@ -472,7 +473,7 @@ parameter to the ``sitemap`` and ``index`` views via the URLconf:: path('custom-sitemap.xml', views.index, { 'sitemaps': sitemaps, 'template_name': 'custom_sitemap.html' - }), + }, name='django.contrib.sitemaps.views.index'), path('custom-sitemap-<section>.xml', views.sitemap, { 'sitemaps': sitemaps, 'template_name': 'custom_sitemap.html' @@ -572,9 +573,13 @@ that: :func:`django.contrib.sitemaps.ping_google()`. ``ping_google`` takes these optional arguments: * ``sitemap_url`` - The absolute path to your site's sitemap (e.g., - :file:`'/sitemap.xml'`). If this argument isn't provided, ``ping_google`` - will attempt to figure out your sitemap by performing a reverse lookup in - your URLconf. + :file:`'/sitemap.xml'`). + + If this argument isn't provided, ``ping_google`` will perform a reverse + lookup in your URLconf, for URLs named + ``'django.contrib.sitemaps.views.index'`` and then + ``'django.contrib.sitemaps.views.sitemap'`` (without further arguments) to + automatically determine the sitemap URL. * ``ping_url`` - Defaults to Google's Ping Tool: https://www.google.com/webmasters/tools/ping. |