updated documentation and added changelog for version 0.4.0

docs/source/changelog.rst

@@ -1,6 +1,13 @@
 Changelog
 =========
 
+* :release:`0.4.0 <2015-08-x>`
+* :support:`-` Ramses now parses RAML using spotify/ramlfications
+* :feature:`-` Renamed authentication setting `ramses.auth` to `auth`
+* :feature:`-` Added 'field' name and 'request' object to processors' arguments
+* :bug:`- major` Fixed processors not applied on fields of type 'list' and type 'dict'
+* :bug:`- major` Fixed a limitation preventing collection names to use nouns that do not have plural forms
+
 * :release:`0.3.1 <2015-07-07>`
 * :support:`- backported` Added support for callables in 'default' field argument
 * :support:`- backported` Added support for 'onupdate' field argument

docs/source/conf.py

@@ -154,7 +154,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

docs/source/fields.rst

@@ -1,8 +1,7 @@
 Field Types
 ===========
 
-Available Types
----------------
+This is a list of all available types:
 
 * biginteger
 * binary
@@ -13,7 +12,7 @@ Available Types
 * decimal
 * dict
 * float
-* foreign_key
+* foreign_key (ignored/not required when using mongodb)
 * id_field
 * integer
 * interval
@@ -101,7 +100,7 @@ Field processors are custom functions that are called upon validation of a field
         }
     }
 
-For relationship fields, you can also add processors to your backref field by adding the ``backref_`` prefix.
+For 'relationship' fields, you can also add processors to your backref field by adding the ``backref_`` prefix.
 
 .. code-block:: json
 
@@ -204,7 +203,7 @@ The ``default`` value can also be set to a Python callable, e.g.
 Update Default Value
 --------------------
 
-You can set an update default value for your field by setting the ``onupdate`` property under ``args``. This is particularly useful to update datetime fields on every updates, e.g.
+You can set an update default value for your field by setting the ``onupdate`` property under ``args``. This is particularly useful to update 'datetime' fields on every updates, e.g.
 
 .. code-block:: json
 

docs/source/getting_started.rst

@@ -1,7 +1,7 @@
 Getting started
 ===============
 
-1. Create your project in a virtualenv directory (see the `virtualenv documentation <https://virtualenv.pypa.io>`_ if you've never done that before)
+1. Create your project in a virtualenv directory (see the `virtualenv documentation <https://virtualenv.pypa.io>`_)
 
 .. code-block:: shell
 
@@ -14,6 +14,15 @@ Getting started
 
 2. Tada! Start editing api.raml to modify the API and items.json for the schema.
 
+
+Requirements
+------------
+
+* Python 2.7, 3.3 or 3.4
+* Elasticsearch (data is automatically indexed for near real-time search)
+* Postgres or Mongodb
+
+
 Tutorials
 ---------
 

docs/source/processors.rst

@@ -25,7 +25,7 @@ E.g.
         return (kwargs['new_value'] or '').lower()
 
 
-To apply processors to your fields, see the :ref:`Field Processors documentation<field-processors>`. Note that you can use Nefertari's `Wrapper API <https://nefertari.readthedocs.org/en/stable/database_backends.html#id1>`_ by importing the engine module: ``from nefertari import engine``.
+To apply processors to your fields, see the :ref:`Field Processors documentation<field-processors>`. Note that you can use Nefertari's `Wrapper API <https://nefertari.readthedocs.org/en/stable/models.html#wrapper-api>`_ by importing the engine module: ``from nefertari import engine``.
 
 
 Other Things You Can Do

docs/source/raml.rst

@@ -3,10 +3,11 @@ RAML Configuration
 
 You can read the full RAML specs `here <http://raml.org/spec.html>`_.
 
+
 Authentication
 --------------
 
-In order to enable authentication, add the ``auth`` paramer to your .ini file.
+In order to enable authentication, add the ``auth`` paramer to your .ini file:
 
 .. code-block:: ini
 
@@ -34,6 +35,7 @@ A few convenience routes will be automatically added:
 * GET ``/auth/logout``: logout currently logged-in user
 * GET ``/users/self``: returns currently logged-in user
 
+
 ACLs
 ----
 
@@ -57,6 +59,7 @@ In your ``securitySchemes``, you can add as many ACLs as you need. Then you can
     /items:
         securedBy: [read_only_users]
 
+
 Enabling HTTP Methods
 ---------------------