From 304786657a8cbff323f21b7297c142f6ca5a1cc1 Mon Sep 17 00:00:00 2001
From: markotibold
Date: Mon, 16 May 2011 23:54:35 +0200
Subject: Getting rid of all errors and warnings that show up when building the
 docs, to make a clean start with the library documentation .

--HG--
rename : docs/library/authenticators.rst => docs/library/authentication.rst
rename : docs/library/emitters.rst => docs/library/renderers.rst
---
 docs/library/authentication.rst |  5 +++++
 docs/library/authenticators.rst |  5 -----
 docs/library/emitters.rst       |  7 -------
 docs/library/modelresource.rst  |  9 ---------
 docs/library/renderers.rst      | 10 ++++++++++
 5 files changed, 15 insertions(+), 21 deletions(-)
 create mode 100644 docs/library/authentication.rst
 delete mode 100644 docs/library/authenticators.rst
 delete mode 100644 docs/library/emitters.rst
 delete mode 100644 docs/library/modelresource.rst
 create mode 100644 docs/library/renderers.rst

(limited to 'docs/library')

diff --git a/docs/library/authentication.rst b/docs/library/authentication.rst
new file mode 100644
index 00000000..d159f605
--- /dev/null
+++ b/docs/library/authentication.rst
@@ -0,0 +1,5 @@
+:mod:`authentication`
+=====================
+
+.. automodule:: authentication
+   :members:
diff --git a/docs/library/authenticators.rst b/docs/library/authenticators.rst
deleted file mode 100644
index 407339f7..00000000
--- a/docs/library/authenticators.rst
+++ /dev/null
@@ -1,5 +0,0 @@
-:mod:`authenticators`
-=====================
-
-.. automodule:: authenticators
-   :members:
diff --git a/docs/library/emitters.rst b/docs/library/emitters.rst
deleted file mode 100644
index 590ace0f..00000000
--- a/docs/library/emitters.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-:mod:`emitters`
-===============
-
-The emitters module provides a set of emitters that can be plugged in to a :class:`.Resource`.  An emitter is responsible for taking the output of a and serializing it to a given media type.  A :class:`.Resource` can have a number of emitters, allow the same content to be serialized in a number of different formats depending on the requesting client's preferences, as specified in the HTTP Request's Accept header.
-
-.. automodule:: emitters
-   :members:
diff --git a/docs/library/modelresource.rst b/docs/library/modelresource.rst
deleted file mode 100644
index af760944..00000000
--- a/docs/library/modelresource.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-:mod:`modelresource`
-====================
-
-.. note::
-
-    TODO - document this module properly
-
-.. automodule:: modelresource
-   :members:
diff --git a/docs/library/renderers.rst b/docs/library/renderers.rst
new file mode 100644
index 00000000..a9e72931
--- /dev/null
+++ b/docs/library/renderers.rst
@@ -0,0 +1,10 @@
+:mod:`renderers`
+================
+
+The renderers module provides a set of renderers that can be plugged in to a :class:`.Resource`.  
+A renderer is responsible for taking the output of a View and serializing it to a given media type.  
+A :class:`.Resource` can have a number of renderers, allow the same content to be serialized in a number
+of different formats depending on the requesting client's preferences, as specified in the HTTP Request's Accept header.
+
+.. automodule:: renderers
+   :members:
-- 
cgit v1.2.3