diff --git a/docs/conf.py b/docs/conf.py index 78534ac3f..163888142 100644 --- a/docs/conf.py +++ b/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__)), 'examples')) +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')) # for importing settings import settings from django.core.management import setup_environ setup_environ(settings) diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 000000000..911ebdf30 --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,9 @@ +.. toctree:: + :maxdepth: 1 + + examples/views + examples/modelviews + examples/objectstore + examples/pygments + examples/blogpost + examples/sandbox diff --git a/docs/examples/blogpost.rst b/docs/examples/blogpost.rst index be91913dc..597d715a6 100644 --- a/docs/examples/blogpost.rst +++ b/docs/examples/blogpost.rst @@ -1,5 +1,3 @@ -.. _blogposts: - Blog Posts API ============== diff --git a/docs/examples/modelviews.rst b/docs/examples/modelviews.rst index c60c9f246..24e35f457 100644 --- a/docs/examples/modelviews.rst +++ b/docs/examples/modelviews.rst @@ -1,5 +1,3 @@ -.. _modelviews: - Getting Started - Model Views ----------------------------- diff --git a/docs/examples/objectstore.rst b/docs/examples/objectstore.rst index 38bdbc983..601eeabbf 100644 --- a/docs/examples/objectstore.rst +++ b/docs/examples/objectstore.rst @@ -1,5 +1,3 @@ -.. _objectstore: - Object Store API ================ diff --git a/docs/examples/pygments.rst b/docs/examples/pygments.rst index b4bc2c166..82a2ceed9 100644 --- a/docs/examples/pygments.rst +++ b/docs/examples/pygments.rst @@ -1,5 +1,3 @@ -.. _codehighlighting: - Code Highlighting API ===================== diff --git a/docs/examples/sandbox.rst b/docs/examples/sandbox.rst index b6658ad9c..ec465aafe 100644 --- a/docs/examples/sandbox.rst +++ b/docs/examples/sandbox.rst @@ -1,5 +1,3 @@ -.. _sandbox: - Sandbox Root API ================ diff --git a/docs/examples/views.rst b/docs/examples/views.rst index 59e13976f..0e02aa29b 100644 --- a/docs/examples/views.rst +++ b/docs/examples/views.rst @@ -1,5 +1,3 @@ -.. _views: - Getting Started - Views ----------------------- diff --git a/docs/index.rst b/docs/index.rst index 6038b7df5..704055dee 100644 --- a/docs/index.rst +++ b/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` -#. :ref:`modelviews` +#. :doc:`examples/views` +#. :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. -#. :ref:`codehighlighting` - 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/objectstore` - Using :class:`views.View` classes for APIs that do not map to models. +#. :doc:`examples/pygments` - Using :class:`views.View` classes with forms for input validation. +#. :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/modelviews - examples/objectstore - examples/pygments - examples/blogpost - examples/sandbox - howto/mixin + examples.rst Indices and tables ------------------