Some initial refactoring of the docs.

docs/conf.py

@@ -14,8 +14,8 @@
 import sys, os
 
 sys.path.insert(0, os.path.dirname(os.path.dirname(__file__)))
-sys.path.insert(0, os.path.join(os.path.dirname(os.path.dirname(__file__)), 'djangorestframework'))
+sys.path.insert(0, os.path.join(os.path.dirname(os.path.dirname(__file__)), 'djangorestframework')) # for documenting the library
-sys.path.insert(0, os.path.join(os.path.dirname(os.path.dirname(__file__)), 'examples'))
+sys.path.insert(0, os.path.join(os.path.dirname(os.path.dirname(__file__)), 'examples')) # for importing settings
 import settings
 from django.core.management import setup_environ
 setup_environ(settings)

docs/examples.rst

@@ -0,0 +1,9 @@
+.. toctree::
+  :maxdepth: 1
+
+  examples/views
+  examples/modelviews
+  examples/objectstore
+  examples/pygments
+  examples/blogpost
+  examples/sandbox

docs/examples/blogpost.rst

@@ -1,5 +1,3 @@
-.. _blogposts:
-
 Blog Posts API
 ==============
 

docs/examples/modelviews.rst

@@ -1,5 +1,3 @@
-.. _modelviews:
-
 Getting Started - Model Views
 -----------------------------
 

docs/examples/objectstore.rst

@@ -1,5 +1,3 @@
-.. _objectstore:
-
 Object Store API
 ================
 

docs/examples/pygments.rst

@@ -1,5 +1,3 @@
-.. _codehighlighting:
-
 Code Highlighting API
 =====================
 

docs/examples/sandbox.rst

@@ -1,5 +1,3 @@
-.. _sandbox:
-
 Sandbox Root API
 ================
 

docs/examples/views.rst

@@ -1,5 +1,3 @@
-.. _views:
-
 Getting Started - Views
 -----------------------
 

docs/index.rst

@@ -87,24 +87,23 @@ Using Django REST framework can be as simple as adding a few lines to your urlco
 
 Django REST framework comes with two "getting started" examples.
 
-#. :ref:`views`
+#. :doc:`examples/views`
-#. :ref:`modelviews`
+#. :doc:`examples/modelviews`
 
 Examples
 --------
 
 There are a few real world web API examples included with Django REST framework.
 
-#. :ref:`objectstore` - Using :class:`views.View` classes for APIs that do not map to models.
+#. :doc:`examples/objectstore` - Using :class:`views.View` classes for APIs that do not map to models.
-#. :ref:`codehighlighting` - Using :class:`views.View` classes with forms for input validation.
+#. :doc:`examples/pygments` - Using :class:`views.View` classes with forms for input validation.
-#. :ref:`blogposts` - Using :class:`views.ModelView` classes for APIs that map directly to models.
+#. :doc:`examples/blogpost` - Using :class:`views.ModelView` classes for APIs that map directly to models.
 
 All the examples are freely available for testing in the sandbox:
 
     http://api.django-rest-framework.org
 
-(The :ref:`sandbox` resource is also documented.)
+(The :doc:`examples/sandbox` resource is also documented.)
-
 
 
 How Tos, FAQs & Notes
@@ -136,19 +135,13 @@ Library Reference
   library/status
   library/views
 
-Examples Reference
+Example Reference
-------------------
+-----------------
 
 .. toctree::
-  :maxdepth: 1
+  :maxdepth: 2
 
-  examples/views
+  examples.rst
-  examples/modelviews
-  examples/objectstore
-  examples/pygments
-  examples/blogpost
-  examples/sandbox
-  howto/mixin
 
 Indices and tables
 ------------------