aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorTom Christie2011-01-28 17:42:57 +0000
committerTom Christie2011-01-28 17:42:57 +0000
commit40f47a9fb31aebd965dce03ae57c036d5360d124 (patch)
tree9e95ee3e500b5c2d8eb4e1adecefaf1d2de47b8a /docs
parent2e9fd9c6b93a77dcf5caa42a4d71b9da2021693f (diff)
downloaddjango-rest-framework-40f47a9fb31aebd965dce03ae57c036d5360d124.tar.bz2
Minor bit of tidy up (all the stuff I noticed when demoing to francis)
Diffstat (limited to 'docs')
-rw-r--r--docs/emitters.rst2
-rw-r--r--docs/index.rst24
2 files changed, 23 insertions, 3 deletions
diff --git a/docs/emitters.rst b/docs/emitters.rst
index fcea6151..590ace0f 100644
--- a/docs/emitters.rst
+++ b/docs/emitters.rst
@@ -1,8 +1,6 @@
:mod:`emitters`
===============
-.. module:: 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
diff --git a/docs/index.rst b/docs/index.rst
index a6bdaab8..10e41f7a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -13,8 +13,30 @@ Some of FlyWheel's features:
* Optional support for forms as input validation.
* Modular architecture - Easy to extend and modify.
+Installation & Setup
+--------------------
+
+blah di blah
+
+Getting Started
+---------------
+
+Blah di blah
+
+
+Examples
+--------
+
+Blah blah blah, examples here.
+
+Add a toctree for examples
+
+
+Library Reference
+-----------------
+
.. toctree::
- :maxdepth: 1
+ :maxdepth: 2
resource
modelresource