diff options
Diffstat (limited to 'docs/ref/contrib/sitemaps.txt')
| -rw-r--r-- | docs/ref/contrib/sitemaps.txt | 18 |
1 files changed, 8 insertions, 10 deletions
diff --git a/docs/ref/contrib/sitemaps.txt b/docs/ref/contrib/sitemaps.txt index a71f19d786..7a66cbe9a9 100644 --- a/docs/ref/contrib/sitemaps.txt +++ b/docs/ref/contrib/sitemaps.txt @@ -1,5 +1,3 @@ -.. _ref-contrib-sitemaps: - ===================== The sitemap framework ===================== @@ -23,10 +21,10 @@ site. The Django sitemap framework automates the creation of this XML file by letting you express this information in Python code. -It works much like Django's :ref:`syndication framework -<ref-contrib-syndication>`. To create a sitemap, just write a +It works much like Django's :doc:`syndication framework +</ref/contrib/syndication>`. To create a sitemap, just write a :class:`~django.contrib.sitemaps.Sitemap` class and point to it in your -:ref:`URLconf <topics-http-urls>`. +:doc:`URLconf </topics/http/urls>`. Installation ============ @@ -52,7 +50,7 @@ Initialization ============== To activate sitemap generation on your Django site, add this line to your -:ref:`URLconf <topics-http-urls>`:: +:doc:`URLconf </topics/http/urls>`:: (r'^sitemap\.xml$', 'django.contrib.sitemaps.views.sitemap', {'sitemaps': sitemaps}) @@ -217,8 +215,8 @@ The sitemap framework provides a couple convenience classes for common cases: .. class:: FlatPageSitemap The :class:`django.contrib.sitemaps.FlatPageSitemap` class looks at all - :mod:`flatpages <django.contrib.flatpages>` defined for the current - :setting:`SITE_ID` (see the + publicly visible :mod:`flatpages <django.contrib.flatpages>` + defined for the current :setting:`SITE_ID` (see the :mod:`sites documentation <django.contrib.sites>`) and creates an entry in the sitemap. These entries include only the :attr:`~Sitemap.location` attribute -- not :attr:`~Sitemap.lastmod`, @@ -227,7 +225,7 @@ The sitemap framework provides a couple convenience classes for common cases: .. class:: GenericSitemap The :class:`django.contrib.sitemaps.GenericSitemap` class works with any - :ref:`generic views <ref-generic-views>` you already have. + :doc:`generic views </ref/generic-views>` you already have. To use it, create an instance, passing in the same :data:`info_dict` you pass to the generic views. The only requirement is that the dictionary have a :data:`queryset` entry. It may also have a :data:`date_field` entry that specifies a @@ -240,7 +238,7 @@ The sitemap framework provides a couple convenience classes for common cases: Example ------- -Here's an example of a :ref:`URLconf <topics-http-urls>` using both:: +Here's an example of a :doc:`URLconf </topics/http/urls>` using both:: from django.conf.urls.defaults import * from django.contrib.sitemaps import FlatPageSitemap, GenericSitemap |