test0908
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Documented ping_google()'s ping_url argument.

This commit is contained in:
Sanyam Khurana 2019-01-11 09:36:20 -05:00 committed by Tim Graham
parent 41e73de39d
commit 6d73278d38
1 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/ref/contrib/sitemaps.txt
View File

@ -481,13 +481,17 @@ You may want to "ping" Google when your sitemap changes, to let it know to
reindex your site. The sitemaps framework provides a function to do just reindex your site. The sitemaps framework provides a function to do just
that: :func:`django.contrib.sitemaps.ping_google()`. that: :func:`django.contrib.sitemaps.ping_google()`.
.. function:: ping_google .. function:: ping_google(sitemap_url=None, ping_url=PING_URL)
:func:`ping_google` takes an optional argument, ``sitemap_url``, ``ping_google`` takes these optional arguments:
which should be the absolute path to your site's sitemap (e.g.,
:file:`'/sitemap.xml'`). If this argument isn't provided, * ``sitemap_url`` - The absolute path to your site's sitemap (e.g.,
:func:`ping_google` will attempt to figure out your :file:`'/sitemap.xml'`). If this argument isn't provided, ``ping_google``
sitemap by performing a reverse looking in your URLconf. will attempt to figure out your sitemap by performing a reverse lookup in
your URLconf.
* ``ping_url`` - Defaults to Google's Ping Tool:
https://www.google.com/webmasters/tools/ping.
:func:`ping_google` raises the exception :func:`ping_google` raises the exception
``django.contrib.sitemaps.SitemapNotFound`` if it cannot determine your ``django.contrib.sitemaps.SitemapNotFound`` if it cannot determine your