put module API documentation into their own files

This commit is contained in:
Martin Baeuml
2011-06-10 17:34:20 +02:00
parent 4dc1efe62e
commit c261c145a7
5 changed files with 92 additions and 83 deletions
-2
View File
@@ -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`:
+3 -81
View File
@@ -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
+36
View File
@@ -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:
+42
View File
@@ -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:
+11
View File
@@ -0,0 +1,11 @@
=====
Scene
=====
This details the scene API.
.. automodule:: sloth.gui.annotationscene
.. autoclass:: AnnotationScene
:members:
:undoc-members: