summaryrefslogtreecommitdiff
path: root/src/zope/traversing/browser/absoluteurl.py
diff options
context:
space:
mode:
authorJason Madden <jamadden@gmail.com>2017-11-08 11:51:03 -0600
committerJason Madden <jamadden@gmail.com>2017-11-08 11:51:03 -0600
commitfbc54516fcdaa1b516606e6ac2c6b569bd25ed94 (patch)
tree7192b316e31a25f7e0b6ddde522a79087fc7868e /src/zope/traversing/browser/absoluteurl.py
parent7e3ebd8032aaa081637bc2c378416da607960584 (diff)
downloadzope-traversing-rtd-docs.tar.gz
Publish docs using Sphinx.rtd-docs
Some doc formatting fixes and cleanups. Add quite a bit of docs about namespaces and the various ones we supply. Fixes #5
Diffstat (limited to 'src/zope/traversing/browser/absoluteurl.py')
-rw-r--r--src/zope/traversing/browser/absoluteurl.py16
1 files changed, 15 insertions, 1 deletions
diff --git a/src/zope/traversing/browser/absoluteurl.py b/src/zope/traversing/browser/absoluteurl.py
index 9b89d46..285b9de 100644
--- a/src/zope/traversing/browser/absoluteurl.py
+++ b/src/zope/traversing/browser/absoluteurl.py
@@ -11,7 +11,12 @@
# FOR A PARTICULAR PURPOSE
#
##############################################################################
-"""Absolute URL View components
+"""
+Absolute URL View components.
+
+These are registered as views and named views (``absolute_url``) if
+you load this package's ``configure.zcml`` with
+:mod:`zope.configuration.xmlconfig`.
"""
try:
from urllib.parse import quote_from_bytes as quote
@@ -52,6 +57,10 @@ class _EncodedUnicode(object):
@implementer(IAbsoluteURL)
class AbsoluteURL(_EncodedUnicode,
BrowserView):
+ """
+ The default implementation of
+ :class:`zope.traversing.browser.interfaces.IAbsoluteURL`.
+ """
def __str__(self):
context = self.context
@@ -131,6 +140,11 @@ class AbsoluteURL(_EncodedUnicode,
@implementer(IAbsoluteURL)
class SiteAbsoluteURL(_EncodedUnicode,
BrowserView):
+ """
+ An implementation of
+ :class:`zope.traversing.browser.interfaces.IAbsoluteURL` for site
+ root objects (:class:`zope.location.interfaces.IRoot`).
+ """
def __str__(self):
context = self.context