Upgrade all the documentation

Author: jorgebastida

dajaxice/core/__init__.py

@@ -7,12 +7,10 @@ class DajaxiceConfig(object):
     """ Provide an easy to use way to read the dajaxice configuration and
     return the default values if no configuration is present."""
 
-    default_config = {'DAJAXICE_MEDIA_PREFIX': 'dajaxice',
-                      'DAJAXICE_DEBUG': False,
-                      'DAJAXICE_NOTIFY_EXCEPTIONS': False,
-                      'DAJAXICE_XMLHTTPREQUEST_JS_IMPORT': True,
+    default_config = {'DAJAXICE_XMLHTTPREQUEST_JS_IMPORT': True,
                       'DAJAXICE_JSON2_JS_IMPORT': True,
-                      'DAJAXICE_EXCEPTION': 'DAJAXICE_EXCEPTION'}
+                      'DAJAXICE_EXCEPTION': 'DAJAXICE_EXCEPTION',
+                      'DAJAXICE_MEDIA_PREFIX': 'dajaxice'}
 
     def __getattr__(self, name):
         """ Return the customized value for a setting (if it exists) or the
@@ -24,6 +22,10 @@ def __getattr__(self, name):
             return self.default_config.get(name)
         return None
 
+    @property
+    def dajaxice_url(self):
+        return r'^%s/' % self.DAJAXICE_MEDIA_PREFIX
+
     def modules(self):
         return dajaxice_functions.modules
 

dajaxice/urls.py

@@ -2,6 +2,6 @@
 from .views import DajaxiceRequest
 
 urlpatterns = patterns('dajaxice.views',
-                url(r'^(.+)/$', DajaxiceRequest.as_view(), name='dajaxice-call-endpoint'),
-                url(r'', DajaxiceRequest.as_view(), name='dajaxice-endpoint'),
-            )
+    url(r'^(.+)/$', DajaxiceRequest.as_view(), name='dajaxice-call-endpoint'),
+    url(r'', DajaxiceRequest.as_view(), name='dajaxice-endpoint'),
+)

docs/available-settings.rst

@@ -1,89 +1,38 @@
 Available Settings
-===========================================
+==================
 
 DAJAXICE_MEDIA_PREFIX
-------------------------
-**Optional**
+-----------------------------------
 
-Dajaxice internally generates urls to every method registered, this prefix will be include in that url. http://domain.com/dajaxice/...
+This will be the namespace that dajaxice will use as endpoint.
 
 Defaults to ``dajaxice``
 
-DAJAXICE_DEBUG
-------------------------
-
-**Optional**
-
-Force/Avoid show debug info in development server.
-
-Defaults to ``True``
-
-DAJAXICE_NOTIFY_EXCEPTIONS
-----------------------------
-
-**Optional**
-
-Force/Avoid send Exception messages to  settings.ADMINS
-
-Defaults to ``False``
-
-DAJAXICE_CACHE_CONTROL
-------------------------
-
-**Optional**
-
-Cache max_age for dajaxice.core.js file.
-
-Defaults to ``5 x 24 x 60 x 60``
+Optional: ``True``
 
 DAJAXICE_XMLHTTPREQUEST_JS_IMPORT
 -----------------------------------
 
-**Optional**
-
-include XmlHttpRequest.js inside dajaxice.core.js
+Include XmlHttpRequest.js inside dajaxice.core.js
 
 Defaults to ``True``
 
+Optional: ``True``
+
 DAJAXICE_JSON2_JS_IMPORT
 -----------------------------------
 
 Include json2.js inside dajaxice.core.js
 
-**Optional**
-
 Defaults to ``True``
 
+Optional: ``True``
+
 DAJAXICE_EXCEPTION
 -----------------------------------
 
-**Optional**
-
 Default data sent when an exception occurs.
 
 Defaults to ``"DAJAXICE_EXCEPTION"``
 
-DAJAXICE_JS_DOCSTRINGS
-------------------------
-
-**Optional**
-
-If True, Dajaxice will add your ajax functions docstrings as a comment before the js functions in dajaxice.core.js
-
-Defaults to ``False``
-
-
-DAJAXICE_FUNCTIONS
------------------------------------
-
-.. note::
-
-    Deprecated since **django-dajaxice 0.1.5**
-
-This option contains a list of all functions callable via ajax.
-
-**Since 0.1.5 dajaxice functions should be registered using.**::
-
-    dajaxice_functions.register(function)
-
-Defaults to ``()``
+Optional: ``True``

docs/conf.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
 # django-dajaxice documentation build configuration file, created by
-# sphinx-quickstart on Wed Nov  3 14:58:47 2010.
+# sphinx-quickstart on Fri May 25 08:02:23 2012.
 #
 # This file is execfile()d with the current directory set to its containing dir.
 #
@@ -18,17 +18,14 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #sys.path.insert(0, os.path.abspath('.'))
 
-from django.conf import settings
-settings.configure()
-
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = []
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -44,16 +41,24 @@
 
 # General information about the project.
 project = u'django-dajaxice'
-copyright = u'2011, Benito Jorge Bastida'
+copyright = u'2012, Jorge Bastida'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
-# The short X.Y version.
-version = '0.2'
-# The full version, including alpha/beta/rc tags.
-release = '0.2'
+import pkg_resources
+try:
+    release = pkg_resources.get_distribution('glue').version
+except pkg_resources.DistributionNotFound:
+    print 'To build the documentation, The distribution information of glue'
+    print 'Has to be available.  Either install the package into your'
+    print 'development environment or run "setup.py develop" to setup the'
+    print 'metadata.  A virtualenv is recommended!'
+    sys.exit(1)
+del pkg_resources
+
+version = '.'.join(release.split('.')[:2])
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -67,7 +72,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = []
+exclude_patterns = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
@@ -182,7 +187,7 @@
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
   ('index', 'django-dajaxice.tex', u'django-dajaxice Documentation',
-   u'Benito Jorge Bastida', 'manual'),
+   u'Jorge Bastida', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -215,5 +220,5 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index', 'django-dajaxice', u'django-dajaxice Documentation',
-     [u'Benito Jorge Bastida'], 1)
+     [u'Jorge Bastida'], 1)
 ]

docs/create-my-first-dajaxice-function.rst

@@ -5,9 +5,6 @@ Custom error callbacks
 How dajaxice handle errors
 ------------------------------
 
-.. note::
-    New in **django-dajaxice 0.2**
-
 When one of your functions raises an exception dajaxice returns as response the ``DAJAXICE_EXCEPTION`` message.
 On every response ``dajaxice.core.js`` checks if that response was an error or not and shows the user a default
 error message ``Something goes wrong``.

docs/csrftoken-issues.rst

@@ -1,11 +1,13 @@
 .. django-dajaxice documentation master file, created by
-   sphinx-quickstart on Wed Nov  3 14:58:47 2010.
+   sphinx-quickstart on Fri May 25 08:02:23 2012.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to dajaxice!
-===========================================
-Dajaxice is the *communication core* of dajaxproject. Its main goal is to trivialize the asynchronous communication within the django server side code and your js code.
+
+django-dajaxice
+===============
+
+Dajaxixe is an Easy to use AJAX library for django. Its main goal is to trivialize the asynchronous communication within the django server code and your js code. Dajaxice uses the unobtrusive standard-compliant (W3C) XMLHttpRequest 1.0 object.
 
 django-dajaxice is a **JS-framework agnostic** library and focuses on decoupling the presentation logic from the server-side logic. dajaxice only requieres **5 minutes to start working.**
 
@@ -18,35 +20,20 @@ Dajaxice has the following aims:
 * Crossbrowsing ready.
 * `Unobtrusive standard-compliant (W3C) XMLHttpRequest 1.0 <http://code.google.com/p/xmlhttprequest/>`_ object usage.
 
-Why should I use dajaxice?
---------------------------
-* Cleaner code. Your ajax functions works uniform.
-* All your presentation logic resides in JS.
-* dajaxice didn’t require any JS Framework.
-
-Gettting Started
---------------------
-If you’re new to dajaxice, you may want to start with these documents:
-
+Documentation
+-------------
 .. toctree::
    :maxdepth: 2
 
    installation
-   create-my-first-dajaxice-function
+   quickstart
+
    custom-error-callbacks
    production-environment
-   migrating-to-02
-   csrftoken-issues
+   migrating-to-05
    available-settings
-   modules.rst
-
-How does it works
-==================
-.. image:: overview.png
-   :scale: 50 %
-   :alt: django-dajaxice overview
-   :align: center
 
+   changelog
 
 Indices and tables
 ==================
@@ -55,11 +42,3 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
-Requirements
---------------------------
-Dajaxice doesn't require any special package to start working.
-
-* Python>=2.4
-* Django>=1.1.4
-
-