diff options
| author | Sanyam Khurana <sanyam.khurana01@gmail.com> | 2019-01-11 09:36:20 -0500 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2019-01-11 09:43:51 -0500 |
| commit | 6d73278d38e65b5785ce67f21c7ef6d7082aec0a (patch) | |
| tree | 2b3fb23674309ebf806ef41304c80230532bff81 /docs | |
| parent | 41e73de39df31c4b13d65462bfeedde6924226d8 (diff) | |
Documented ping_google()'s ping_url argument.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/contrib/sitemaps.txt | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/docs/ref/contrib/sitemaps.txt b/docs/ref/contrib/sitemaps.txt index 67ba9e60bb..3ba601bc67 100644 --- a/docs/ref/contrib/sitemaps.txt +++ b/docs/ref/contrib/sitemaps.txt @@ -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 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``, - which should be the absolute path to your site's sitemap (e.g., - :file:`'/sitemap.xml'`). If this argument isn't provided, - :func:`ping_google` will attempt to figure out your - sitemap by performing a reverse looking in your URLconf. + ``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. + + * ``ping_url`` - Defaults to Google's Ping Tool: + https://www.google.com/webmasters/tools/ping. :func:`ping_google` raises the exception ``django.contrib.sitemaps.SitemapNotFound`` if it cannot determine your |
