Commits

Chris Mutel committed fdd404b

Moved docs to outer dir

  • Participants
  • Parent commits 017a87d

Comments (0)

Files changed (2)

django_dag/docs/rst/index.rst

-Introduction
-============
-
-* django-acyclic * provides handling of directed acyclic graphs of generic objects in the Django web framework. Currently, only PostgreSQL is supported.
-
-Simple Example
---------------
-
-::
-
-    from dag.mixins import GraphMixin
-    from dag.models import Edge, Graph
-    
-    class Continent(GraphMixin):
-        name = models.TextField()
-    
-    class Country(GraphMixin):
-        name = models.TextField()
-    
-    class City(GraphMixin):
-        name = models.TextField()
-    
-    graph = Graph.objects.create(name="example graph")
-    Europe = Continent.objects.create(name="Europe")
-    Switzerland = Country.objects.create(name="Switzerland")
-    Zurich = City.objects.create(name="Zurich")
-    # One way to create edges
-    Edge.objects.create(node_from=Europe, node_to=Switzerland)
-    # Another way to create edges
-    Switzerland.link_to(Zurich)
-    Europe.get_descendants() == [Switzerland, Zurich]
-    >>> True
-    graph.is_heterogeneous
-    >>> True
-    graph.root_node_objects
-    >>> [Europe,]
-
-Prerequisites
--------------
-
-- Django >= 1.1
-- PostgreSQL >= 8.0
-

docs/rst/index.rst

+Introduction
+============
+
+* django-acyclic * provides handling of directed acyclic graphs of generic objects in the Django web framework. Currently, only PostgreSQL is supported.
+
+Simple Example
+--------------
+
+::
+
+    from dag.mixins import GraphMixin
+    from dag.models import Edge, Graph
+    
+    class Continent(GraphMixin):
+        name = models.TextField()
+    
+    class Country(GraphMixin):
+        name = models.TextField()
+    
+    class City(GraphMixin):
+        name = models.TextField()
+    
+    graph = Graph.objects.create(name="example graph")
+    Europe = Continent.objects.create(name="Europe")
+    Switzerland = Country.objects.create(name="Switzerland")
+    Zurich = City.objects.create(name="Zurich")
+    # One way to create edges
+    Edge.objects.create(node_from=Europe, node_to=Switzerland)
+    # Another way to create edges
+    Switzerland.link_to(Zurich)
+    Europe.get_descendants() == [Switzerland, Zurich]
+    >>> True
+    graph.is_heterogeneous
+    >>> True
+    graph.root_node_objects
+    >>> [Europe,]
+
+Prerequisites
+-------------
+
+- Django >= 1.1
+- PostgreSQL >= 8.0
+