doc updates

- split item and inserters api documentation
- fix some links
- fix warning about too short title underlines
- fix code for importing default config
- update front page/index

doc/api/index.rst

@@ -10,6 +10,7 @@ API Reference
    labeltool
    containers
    model
-   scene
    items
+   inserters
+   scene
 

doc/api/items.rst

@@ -4,9 +4,9 @@ Items
 
 This details the default visualization items that come with sloth.
 
-The following items are available in :mod:`sloth.items.items`:
+The following items are available in :mod:`sloth.items`:
 
-.. automodule:: sloth.items
+.. module:: sloth.items
 
 .. autoclass:: BaseItem
     :members:
@@ -23,14 +23,3 @@ The following items are available in :mod:`sloth.items.items`:
 .. .. autoclass:: PolygonItem
     :members:
 
-.. autoclass:: PointItemInserter
-    :members:
-    :undoc-members:
-
-.. autoclass:: RectItemInserter
-    :members:
-    :undoc-members:
-
-.. .. autoclass:: PolygonItemInserter
-    :members:
-    :undoc-members:

doc/api/model.rst

@@ -5,6 +5,7 @@ Model
 This details the model API.
 
 .. automodule:: sloth.annotations.model
+
 .. autoclass:: AnnotationModel
     :members:
     :undoc-members:

doc/concepts.rst

@@ -105,7 +105,7 @@ Of course, you can also change the type::
 
 However, if you do this you will need to tell the label tool in the
 configuration how to display this type as well.  See section
-:doc:`Configuration` on how to do that.
+:doc:`configuration` on how to do that.
 
 
 Representation is not storage
@@ -117,7 +117,7 @@ very different.  Sloth does not have *the one* way in which way to store the
 labels.  Again, there are some default formats which the label tool can deal
 with out of the box (among others YAML and JSON, which resemble the textual
 representation above).  However, you are free to define your own loading and
-saving routines for your labels (see :doc:`Containers`). This allows you for
+saving routines for your labels (see :doc:`containers`). This allows you for
 example to support legacy third-party label formats without the need of
 converting them to JSON first.
 

doc/configuration.rst

@@ -49,8 +49,8 @@ different keys of the dictionary in detail:
   ``sloth.items.RectItem`` class, which will draw a rectangle as given by the
   coordinates in the annotation.  Sloth comes with several predefined
   visualization classes, such as ``sloth.items.RectItem`` and
-  ``sloth.items.PointItem`` (see :ref:`items` for a full list).  However, it is
-  also very easy to define your own visualization class (see :ref:`items`).
+  ``sloth.items.PointItem`` (see :doc:`items` for a full list).  However, it is
+  also very easy to define your own visualization class (see :ref:`CUSTOM_ITEMS`).
 
 * ``inserter`` specifies which class is responsible for creating new
   annotations based on user input.  When the user enters insert mode with a
@@ -145,7 +145,7 @@ the default values, you can first import the default configuration and then
 append your custom mappings (remember that the configuration is a python
 module, you can basically execute any valid python code)::
 
-    from conf.default_config import LABELS
+    from sloth.conf.default_config import LABELS
 
     MYLABLES = ({
        ...

doc/containers.rst

@@ -72,7 +72,7 @@ Writes and reads annotations in YAML format (needs the python module ``yaml``
 to be installed).
 
 PickleContainer
--------------
+---------------
 
 Default pattern: ``*.pickle``
 
@@ -91,7 +91,7 @@ used for saving though, otherwise the labels will be lost. (write support
 not implemented yet anyway)
 
 FeretContainer
--------------
+--------------
 
 Reads annotations in the Feret format (no write support implemented yet).
 This container is not included in the default configuration.

doc/index.rst

@@ -3,29 +3,29 @@
     :align: right
     :alt: sloth
 
-========================================
-Welcome to the label tool documentation!
-========================================
+=================================
+Welcome to Sloth's documentation!
+=================================
 
-This is the documentation of the label tool.  The label tool's purpose is to
-provide a versatile tool for various labeling tasks in the context of computer
-vision research.  Since there are so many different label formats and
-requirements out there, we concluded that is virtually impossible to build *the
-one* label tool sufficient to handle all labeling tasks.  Therefore, this
-project can be seen rather as a framework and set of standard components to
-quickly configure a label tool specificly tailored to ones needs.
+This is the documentation of Sloth.  Sloth's purpose is to provide a versatile
+tool for various labeling tasks in the context of computer vision research.
+Since there are so many different label formats and requirements out there, we
+concluded that is virtually impossible to build *the one* label tool sufficient
+to handle all labeling tasks.  Therefore, this project can be seen rather as a
+framework and set of standard components to quickly configure a label tool
+specificly tailored to ones needs.
 
-In this documentation we will go over some of the key concepts of the label tool,
-how to configure the label tool using the standard components provided in the package,
-and finally how to go further and write specific visualization items and label format
-loaders to deal with specific labeling needs.
+In this documentation we will go over some of the key concepts of Sloth, how to
+configure Sloth using the standard components provided in the package, and
+finally how to go further and write custom visualization items and label
+format containers to deal with specific labeling needs.
 
 Feedback
 ========
 
-*Please* provide feedback to me on this document and the label tool!  I won't be able
-to incorporate your required features if you do not talk to me.  Also, use the bug tracker
-at https://github.com/baeuml/sloth/issues.  Of course, similarly welcome are patches!
+*Please* provide feedback to us on this document and Sloth in general!  We won't be able
+to incorporate your required features if you do not talk to us.  Also, use the bug tracker
+at https://github.com/cvhciKIT/sloth/issues.  Of course, similarly welcome are patches!
 
 Contents
 ========

doc/items.rst

@@ -54,6 +54,8 @@ Usage:
   * Can be moved by Left/Right/Up/Down keys.  If Shift is pressed, step is increased.  If Control is pressed,
     width and height are modified instead of position.
 
+.. _CUSTOM_ITEMS:
+
 Write your own visualization item
 =================================