Revision: 609
Author: batiste.bieler
Date: Mon Jul 20 11:06:47 2009
Log: Add some API doc
http://code.google.com/p/django-page-cms/source/detail?r=609
Added:
/trunk/docs/page-api.rst
Modified:
/trunk/docs/conf.py
/trunk/docs/index.rst
=======================================
--- /dev/null
+++ /trunk/docs/page-api.rst Mon Jul 20 11:06:47 2009
@@ -0,0 +1,17 @@
+==================
+Page reference API
+==================
+
+Page Model
+==========
+
+.. autoclass:: pages.models.Page
+ :members:
+ :undoc-members:
+
+Page Manager
+============
+
+.. autoclass:: pages.managers.PageManager
+ :members:
+ :undoc-members:
=======================================
--- /trunk/docs/conf.py Mon Jul 20 10:08:13 2009
+++ /trunk/docs/conf.py Mon Jul 20 11:06:47 2009
@@ -19,7 +19,18 @@
# If your extensions (or modules documented by autodoc) are in another
directory,
# add these directories to sys.path here. If the directory is relative to
the
# documentation root, use os.path.abspath to make it absolute, like shown
here.
-sys.path.append(os.path.abspath('..'))
+
+sys.path.append(os.path.abspath('../'))
+
+import pages
+from django.conf import settings
+settings.configure(DEBUG=True, TEMPLATE_DEBUG=True,
+ 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/index.rst Mon Jul 20 10:08:13 2009
+++ /trunk/docs/index.rst Mon Jul 20 11:06:47 2009
@@ -7,6 +7,7 @@
:maxdepth: 2
installation.rst
+ page-api.rst
Indices and tables
==================
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
