add container API reference

This commit is contained in:
Martin Baeuml
2011-06-07 16:47:30 +02:00
parent dc74eef969
commit 022b0c2882
4 changed files with 65 additions and 8 deletions
+25
View File
@@ -0,0 +1,25 @@
==========
Containers
==========
.. module:: sloth.annotations.container
This details the default containers that come with sloth.
The following containers are available in :mod:`sloth.annotations.container`:
.. automodule:: sloth.annotations.container
.. autoclass:: AnnotationContainer
:members:
.. autoclass:: JsonContainer
:members:
.. autoclass:: YamlContainer
:members:
.. autoclass:: PickleContainer
:members:
.. autoclass:: FeretContainer
:members:
+92
View File
@@ -0,0 +1,92 @@
=============
API Reference
=============
.. todo:: Actually document the code, so that this is not just a bunch of method names.
.. toctree::
:maxdepth: 1
containers
models
annotationmodel
===============
.. automodule:: 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:: annotations.container
.. autoclass:: AnnotationContainer
:members:
annotationscene
===============
.. automodule:: annotationscene
.. autoclass:: AnnotationScene
:members:
:undoc-members:
items
=====
.. automodule:: 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: