Revision: 618
Author: batiste.bieler
Date: Sun Jul 26 07:34:43 2009
Log: Improve a little bit sphinx documentation
http://code.google.com/p/django-page-cms/source/detail?r=618
Modified:
/trunk/docs/conf.py
/trunk/docs/page-api.rst
/trunk/pages/http.py
/trunk/pages/managers.py
/trunk/pages/models.py
/trunk/pages/urls.py
=======================================
--- /trunk/docs/conf.py Mon Jul 20 23:57:02 2009
+++ /trunk/docs/conf.py Sun Jul 26 07:34:43 2009
@@ -28,9 +28,6 @@
DEFAULT_PAGE_TEMPLATE='index.html',
PAGE_TAGGING=False,
TEMPLATE_DIRS=('/home/web-apps/myapp', '/home/web-apps/base'))
-"""from django.conf import settings
-if not settings.configured:
- settings.configure()"""
# General configuration
# ---------------------
=======================================
--- /trunk/docs/page-api.rst Wed Jul 22 00:07:24 2009
+++ /trunk/docs/page-api.rst Sun Jul 26 07:34:43 2009
@@ -30,6 +30,36 @@
:members:
:undoc-members:
+PageAlias Model
+===============
+
+.. autoclass:: pages.models.PageAlias
+ :members:
+ :undoc-members:
+
+PageAlias Manager
+=================
+
+.. autoclass:: pages.managers.PageAliasManager
+ :members:
+ :undoc-members:
+
+PagePermission Model
+====================
+
+.. autoclass:: pages.models.PagePermission
+ :members:
+ :undoc-members:
+
+PagePermission Manager
+======================
+
+.. autoclass:: pages.managers.PagePermissionManager
+ :members:
+ :undoc-members:
+
+
+
Utils
=====
=======================================
--- /trunk/pages/http.py Wed Jul 22 00:07:24 2009
+++ /trunk/pages/http.py Sun Jul 26 07:34:43 2009
@@ -1,4 +1,4 @@
-"""Page CMS functions related to the request object"""
+"""Page CMS functions related to the request object."""
from django.core.handlers.base import BaseHandler
from django.core.handlers.wsgi import WSGIRequest
from django.http import HttpResponse, HttpResponseRedirect
=======================================
--- /trunk/pages/managers.py Wed Jul 22 00:07:24 2009
+++ /trunk/pages/managers.py Sun Jul 26 07:34:43 2009
@@ -28,6 +28,8 @@
"""
def on_site(self, site_id=None):
+ """Return a ``QuerySet`` of pages that are published on the site
+ defined by the ``SITE_ID`` setting."""
if settings.PAGE_USE_SITE_ID:
if not site_id:
site_id = settings.SITE_ID
@@ -35,12 +37,12 @@
return self
def root(self):
- """Return a queryset with pages that don't have parents."""
+ """Return a ``QuerySet`` of pages without parent."""
return self.filter(parent__isnull=True)
def valid_targets(self, page_id, perms="All", page=None):
- """return a ``QuerySet`` of valid targets for moving a page into
the
- tree"""
+ """Return a ``QuerySet`` of valid targets for moving a page into
the
+ tree."""
if page is None:
page = self.get(pk=page_id)
exclude_list = []
@@ -203,12 +205,12 @@
AND pages_content.body =%s)
GROUP BY pages_content.page_id'''
- cursor = connection.cursor()
+ cursor = connection.curr()
cursor.execute(sql, ('slug', slug, ))
return [c[0] for c in cursor.fetchall()]
class PagePermissionManager(models.Manager):
- """Hierachic page permission"""
+ """Hierachic page permission manager."""
def get_page_id_list(self, user):
"""Give a list of ``Page`` ids where the user has rights or the
string
@@ -228,12 +230,13 @@
return id_list
class PageAliasManager(models.Manager):
- """PageAlias manager"""
+ """PageAlias manager."""
def get_for_url(self, request, path=None, lang=None):
"""
- resolve a request to an alias. returns a PageAlias object or None
if the url
- matches no page at all. The aliasing system supports plain aliases
(/foo/bar)
- as well as aliases containing GET parameters
(like "index.php?page=foo").
+ Resolve a request to an alias. returns a ``PageAlias`` object or
None
+ if the url matches no page at all. The aliasing system supports
plain
+ aliases (``/foo/bar``) as well as aliases containing GET parameters
+ (like ``index.php?page=foo``).
"""
from pages.utils import normalize_url
from pages.models import Page,PageAlias
=======================================
--- /trunk/pages/models.py Wed Jul 22 12:37:02 2009
+++ /trunk/pages/models.py Sun Jul 26 07:34:43 2009
@@ -144,7 +144,7 @@
def get_languages(self):
"""
- return a list of all existing languages for this page.
+ Return a list of all existing languages for this page.
"""
languages = cache.get(self.PAGE_LANGUAGES_KEY % (self.id))
if languages:
@@ -159,10 +159,10 @@
return languages
def get_absolute_url(self, language=None):
+ """Return the absolute page url. Add the language prefix if
+ ``PAGE_USE_LANGUAGE_PREFIX`` is set to **True***."""
try:
alias = PageAlias.objects.get(page=self, is_canonical=True)
- #if settings.PAGE_USE_LANGUAGE_PREFIX:
- # url = str(language) + '/' + self.url
return reverse('pages-root')[:-1] + alias.url
except:
url = reverse('pages-root')
@@ -171,9 +171,7 @@
return url + self.get_url(language)
def get_url(self, language=None):
- """
- get the url of this page, adding parent's slug
- """
+ """Return url of this page, adding all parent's slug."""
url = cache.get(self.PAGE_URL_KEY % (self.id, language))
if url:
return url
=======================================
--- /trunk/pages/urls.py Tue Jul 21 01:02:49 2009
+++ /trunk/pages/urls.py Sun Jul 26 07:34:43 2009
@@ -11,10 +11,10 @@
if settings.PAGE_USE_LANGUAGE_PREFIX:
urlpatterns += patterns('',
url(r'^(?P<lang>[-\w]+)/(?P<path>.*)$', alias_wrapper,
- name='pages-details-by-slug'),
+ name='pages-details-by-path'),
)
else:
urlpatterns += patterns('',
url(r'^(?P<path>.*)$', alias_wrapper,
- name='pages-details-by-slug'),
- )
+ name='pages-details-by-path'),
+ )
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"pinax-updates" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/pinax-updates?hl=en
-~----------~----~----~----~------~----~------~--~---
