From c261c145a73446906bf2506aaa0a8efc184dbb2e Mon Sep 17 00:00:00 2001
From: Martin Baeuml <baeuml@kit.edu>
Date: Fri, 10 Jun 2011 17:34:20 +0200
Subject: [PATCH] put module API documentation into their own files

---
 doc/api/containers.rst |  2 -
 doc/api/index.rst      | 84 ++----------------------------------------
 doc/api/items.rst      | 36 ++++++++++++++++++
 doc/api/model.rst      | 42 +++++++++++++++++++++
 doc/api/scene.rst      | 11 ++++++
 5 files changed, 92 insertions(+), 83 deletions(-)
 create mode 100644 doc/api/items.rst
 create mode 100644 doc/api/model.rst
 create mode 100644 doc/api/scene.rst

diff --git a/doc/api/containers.rst b/doc/api/containers.rst
index 830affc..ff127c7 100644
--- a/doc/api/containers.rst
+++ b/doc/api/containers.rst
@@ -2,8 +2,6 @@
 Containers
 ==========
 
-.. module:: sloth.annotations.container
-
 This details the default containers that come with sloth.
 
 The following containers are available in :mod:`sloth.annotations.container`:
diff --git a/doc/api/index.rst b/doc/api/index.rst
index fb79272..8d6b549 100644
--- a/doc/api/index.rst
+++ b/doc/api/index.rst
@@ -8,85 +8,7 @@ API Reference
    :maxdepth: 1
 
    containers
-   models
-
-annotationmodel
-===============
-
-.. automodule:: sloth.annotations.model
-.. autoclass:: AnnotationModel
-    :members:
-    :undoc-members:
-.. autoclass:: ModelItem
-    :members:
-    :undoc-members:
-.. autoclass:: RootModelItem
-    :members:
-    :undoc-members:
-.. autoclass:: FileModelItem
-    :members:
-    :undoc-members:
-.. autoclass:: ImageFileModelItem
-    :members:
-    :undoc-members:
-.. autoclass:: VideoFileModelItem
-    :members:
-    :undoc-members:
-.. autoclass:: FrameModelItem
-    :members:
-    :undoc-members:
-.. autoclass:: AnnotationModelItem
-    :members:
-    :undoc-members:
-.. autoclass:: KeyValueModelItem
-    :members:
-    :undoc-members:
-
-annotation.container
-====================
-.. automodule:: sloth.annotations.container
-.. autoclass:: AnnotationContainer
-    :members:
-
-annotationscene
-===============
-
-.. automodule:: sloth.annotationscene
-.. autoclass:: AnnotationScene
-    :members:
-    :undoc-members:
-
-items
-=====
-
-.. automodule:: sloth.items
-
-.. _AnnotationGraphicsItem:
-
-.. autoclass:: AnnotationGraphicsItem
-    :members:
-    :undoc-members:
-
-.. autoclass:: PointItem
-    :members:
-    :undoc-members:
-
-.. autoclass:: RectItem
-    :members:
-    :undoc-members:
-
-.. .. autoclass:: PolygonItem
-    :members:
-
-.. autoclass:: PointItemInserter
-    :members:
-    :undoc-members:
-
-.. autoclass:: RectItemInserter
-    :members:
-    :undoc-members:
-
-.. autoclass:: PolygonItemInserter
-    :members:
-    :undoc-members:
+   model
+   scene
+   items
 
diff --git a/doc/api/items.rst b/doc/api/items.rst
new file mode 100644
index 0000000..0659347
--- /dev/null
+++ b/doc/api/items.rst
@@ -0,0 +1,36 @@
+=====
+Items
+=====
+
+This details the default visualization items that come with sloth.
+
+The following items are available in :mod:`sloth.items.items`:
+
+.. automodule:: sloth.items
+
+.. autoclass:: BaseItem
+    :members:
+    :undoc-members:
+
+.. autoclass:: PointItem
+    :members:
+    :undoc-members:
+
+.. autoclass:: RectItem
+    :members:
+    :undoc-members:
+
+.. .. autoclass:: PolygonItem
+    :members:
+
+.. autoclass:: PointItemInserter
+    :members:
+    :undoc-members:
+
+.. autoclass:: RectItemInserter
+    :members:
+    :undoc-members:
+
+.. .. autoclass:: PolygonItemInserter
+    :members:
+    :undoc-members:
diff --git a/doc/api/model.rst b/doc/api/model.rst
new file mode 100644
index 0000000..4de54ce
--- /dev/null
+++ b/doc/api/model.rst
@@ -0,0 +1,42 @@
+=====
+Model
+=====
+
+This details the model API.
+
+.. automodule:: sloth.annotations.model
+.. autoclass:: AnnotationModel
+    :members:
+    :undoc-members:
+
+.. autoclass:: ModelItem
+    :members:
+    :undoc-members:
+
+.. autoclass:: RootModelItem
+    :members:
+    :undoc-members:
+
+.. autoclass:: FileModelItem
+    :members:
+    :undoc-members:
+
+.. autoclass:: ImageFileModelItem
+    :members:
+    :undoc-members:
+
+.. autoclass:: VideoFileModelItem
+    :members:
+    :undoc-members:
+
+.. autoclass:: FrameModelItem
+    :members:
+    :undoc-members:
+
+.. autoclass:: AnnotationModelItem
+    :members:
+    :undoc-members:
+
+.. autoclass:: KeyValueModelItem
+    :members:
+    :undoc-members:
diff --git a/doc/api/scene.rst b/doc/api/scene.rst
new file mode 100644
index 0000000..3eb8a92
--- /dev/null
+++ b/doc/api/scene.rst
@@ -0,0 +1,11 @@
+=====
+Scene
+=====
+
+This details the scene API.
+
+.. automodule:: sloth.gui.annotationscene
+.. autoclass:: AnnotationScene
+    :members:
+    :undoc-members:
+