summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim Graham <timograham@gmail.com>2016-03-09 10:00:27 -0500
committerTim Graham <timograham@gmail.com>2016-03-09 10:01:21 -0500
commite8d94cda9b4f30f6724f919882b61eb3279efafc (patch)
treed5e7e3c8aa55dd707097c8bbcc18c689cc029c52 /docs
parent05ca9a68b59d5d683501e709c1ab629c3705fecb (diff)
[1.9.x] Wrapped some lines and added links to docs/ref/contrib/sitemaps.txt.
Backport of a496d10a8c3b8b3080f0daa7348b33aed790a967 from master
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/contrib/sitemaps.txt37
1 files changed, 21 insertions, 16 deletions
diff --git a/docs/ref/contrib/sitemaps.txt b/docs/ref/contrib/sitemaps.txt
index 8d8b411b53..a5eac07824 100644
--- a/docs/ref/contrib/sitemaps.txt
+++ b/docs/ref/contrib/sitemaps.txt
@@ -123,7 +123,7 @@ Note:
corresponding to a sitemap property (:attr:`~Sitemap.location`,
:attr:`~Sitemap.lastmod`, :attr:`~Sitemap.changefreq`, and
:attr:`~Sitemap.priority`).
-* :attr:`~Sitemap.lastmod` should return a Python ``datetime`` object.
+* :attr:`~Sitemap.lastmod` should return a :class:`~datetime.datetime`.
* There is no :attr:`~Sitemap.location` method in this example, but you
can provide it in order to specify the URL for your object. By default,
:attr:`~Sitemap.location()` calls ``get_absolute_url()`` on each object
@@ -173,11 +173,11 @@ Note:
**Optional.** Either a method or attribute.
- If it's a method, it should take one argument -- an object as returned by
- :attr:`~Sitemap.items()` -- and return that object's last-modified date/time, as a Python
- ``datetime.datetime`` object.
+ If it's a method, it should take one argument -- an object as returned
+ by :attr:`~Sitemap.items()` -- and return that object's last-modified
+ date/time as a :class:`~datetime.datetime`.
- If it's an attribute, its value should be a Python ``datetime.datetime`` object
+ If it's an attribute, its value should be a :class:`~datetime.datetime`
representing the last-modified date/time for *every* object returned by
:attr:`~Sitemap.items()`.
@@ -192,13 +192,15 @@ Note:
**Optional.** Either a method or attribute.
- If it's a method, it should take one argument -- an object as returned by
- :attr:`~Sitemap.items()` -- and return that object's change frequency, as a Python string.
+ If it's a method, it should take one argument -- an object as returned
+ by :attr:`~Sitemap.items()` -- and return that object's change
+ frequency as a string.
- If it's an attribute, its value should be a string representing the change
- frequency of *every* object returned by :attr:`~Sitemap.items()`.
+ If it's an attribute, its value should be a string representing the
+ change frequency of *every* object returned by :attr:`~Sitemap.items()`.
- Possible values for :attr:`~Sitemap.changefreq`, whether you use a method or attribute, are:
+ Possible values for :attr:`~Sitemap.changefreq`, whether you use a
+ method or attribute, are:
* ``'always'``
* ``'hourly'``
@@ -212,14 +214,17 @@ Note:
**Optional.** Either a method or attribute.
- If it's a method, it should take one argument -- an object as returned by
- :attr:`~Sitemap.items()` -- and return that object's priority, as either a string or float.
+ If it's a method, it should take one argument -- an object as returned
+ by :attr:`~Sitemap.items()` -- and return that object's priority as
+ either a string or float.
- If it's an attribute, its value should be either a string or float representing
- the priority of *every* object returned by :attr:`~Sitemap.items()`.
+ If it's an attribute, its value should be either a string or float
+ representing the priority of *every* object returned by
+ :attr:`~Sitemap.items()`.
- Example values for :attr:`~Sitemap.priority`: ``0.4``, ``1.0``. The default priority of a
- page is ``0.5``. See the `sitemaps.org documentation`_ for more.
+ Example values for :attr:`~Sitemap.priority`: ``0.4``, ``1.0``. The
+ default priority of a page is ``0.5``. See the `sitemaps.org
+ documentation`_ for more.
.. _sitemaps.org documentation: http://www.sitemaps.org/protocol.html#prioritydef