Merge pull request #47 from pstch/routers

Cleanup docs
pstch · Jun 28, 2014 · 0c9694e · 0c9694e
2 parents 483a9ff + 08e1f61
commit 0c9694e
Show file tree

Hide file tree

Showing 3 changed files with 62 additions and 75 deletions.
diff --git a/django_crucrudile/routers/__init__.py b/django_crucrudile/routers/__init__.py
@@ -382,78 +382,4 @@ class ModelRouter(BaseModelRouter):
     itself instantiated, using
     :func:`django_crucrudile.entities.store.EntityStore.register_base_store`.
 
-    The following graph may help to explain the relation
-    between the generic views, routes and routers :
-
-    .. graphviz::
-
-       digraph model_router {
-           bgcolor="transparent"
-           edge[dir=back, fontsize=10]
-           node[fontsize=12]
-
-           subgraph baseview {
-               edge[label="Subclasses", color="#eeeeee",
-                    fontcolor="#555555", fontsize=7]
-               node[style=filled, color="#eeeeee",
-                    fontcolor="#555555", fontsize=10]
-
-               "Entity" [fontcolor=black, color="#dddddd",
-                         fontsize=12]
-
-               "Entity" -> "Router"
-
-               "EntityStore" -> "Router"
-               "Router" -> "BaseModelRouter"
-               "BaseModelRouter" -> "ModelRouter"
-
-               "Entity" -> "Route"
-
-               "Route" -> "ModelRoute"
-               "Route" -> "ViewRoute"
-
-               "ModelRoute" -> "ModelViewRoute"
-               "ViewRoute" -> "ModelViewRoute"
-
-               "ModelViewRoute" -> "ListViewRoute"
-               "ModelViewRoute" -> "DetailViewRoute"
-               "ModelViewRoute" -> "CreateViewRoute"
-               "ModelViewRoute" -> "UpdateViewRoute"
-               "ModelViewRoute" -> "DeleteViewRoute"
-
-           }
-
-           subgraph routes {
-               node[style=filled]
-               "ListViewRoute"
-               "DetailViewRoute"
-               "CreateViewRoute"
-               "UpdateViewRoute"
-               "DeleteViewRoute"
-           }
-
-           subgraph views {
-               node[style=dashed, color=gray,
-                    fontcolor=gray, constraint=false, fontsize=8]
-               edge[style=dashed, color=gray,
-                    fontcolor=gray, label="Callback", fontsize=8]
-               "ListView" -> "ListViewRoute"
-               "DetailView" -> "DetailViewRoute"
-               "CreateView" -> "CreateViewRoute"
-               "UpdateView" -> "UpdateViewRoute"
-               "DeleteView" -> "DeleteViewRoute"
-           }
-
-           subgraph router {
-               node[style=filled, color=black, fontcolor=white]
-               edge[label="Provides", fontsize=10]
-               "ListViewRoute" -> "ModelRouter"
-               "DetailViewRoute" -> "ModelRouter"
-               "CreateViewRoute" -> "ModelRouter"
-               "UpdateViewRoute" -> "ModelRouter"
-               "DeleteViewRoute" -> "ModelRouter"
-           }
-
-       }
-
     """
diff --git a/docs/conf.py b/docs/conf.py
@@ -279,6 +279,6 @@
 autodoc_member_order = 'bysource'
 
 inheritance_graph_attrs = dict(
-    rankdir="TB", ratio='compress'
+    rankdir="TB", ratio='compress', bgcolor='transparent'
 )
 modindex_common_prefix = ['django_crucrudile.']
diff --git a/docs/routers.rst b/docs/routers.rst
@@ -27,3 +27,64 @@ Model router
    :members:
    :undoc-members:
    :show-inheritance:
+
+The following graph may help to explain the relation between the
+generic views, routes and routers :
+
+.. graphviz::
+
+   digraph model_router {
+       bgcolor="transparent"
+       edge[dir=back, fontsize=10]
+       node[fontsize=12]
+        subgraph baseview {
+           edge[label="Subclasses", color="#eeeeee",
+                fontcolor="#555555", fontsize=7]
+           node[style=filled, color="#eeeeee",
+                fontcolor="#555555", fontsize=10]
+            "Entity" [fontcolor=black, color="#dddddd",
+                     fontsize=12]
+            "Entity" -> "Router"
+            "EntityStore" -> "Router"
+           "Router" -> "BaseModelRouter"
+           "BaseModelRouter" -> "ModelRouter"
+            "Entity" -> "Route"
+            "Route" -> "ModelRoute"
+           "Route" -> "ViewRoute"
+            "ModelRoute" -> "ModelViewRoute"
+           "ViewRoute" -> "ModelViewRoute"
+            "ModelViewRoute" -> "ListViewRoute"
+           "ModelViewRoute" -> "DetailViewRoute"
+           "ModelViewRoute" -> "CreateViewRoute"
+           "ModelViewRoute" -> "UpdateViewRoute"
+           "ModelViewRoute" -> "DeleteViewRoute"
+        }
+        subgraph routes {
+           node[style=filled]
+           "ListViewRoute"
+           "DetailViewRoute"
+           "CreateViewRoute"
+           "UpdateViewRoute"
+           "DeleteViewRoute"
+       }
+        subgraph views {
+           node[style=dashed, color=gray,
+                fontcolor=gray, constraint=false, fontsize=8]
+           edge[style=dashed, color=gray,
+                fontcolor=gray, label="Callback", fontsize=8]
+           "ListView" -> "ListViewRoute"
+           "DetailView" -> "DetailViewRoute"
+           "CreateView" -> "CreateViewRoute"
+           "UpdateView" -> "UpdateViewRoute"
+           "DeleteView" -> "DeleteViewRoute"
+       }
+        subgraph router {
+           node[style=filled, color=black, fontcolor=white]
+           edge[label="Provides", fontsize=10]
+           "ListViewRoute" -> "ModelRouter"
+           "DetailViewRoute" -> "ModelRouter"
+           "CreateViewRoute" -> "ModelRouter"
+           "UpdateViewRoute" -> "ModelRouter"
+           "DeleteViewRoute" -> "ModelRouter"
+       }
+    }