Change API docs structure

alankbi · Jan 21, 2020 · bcb3336 · bcb3336
1 parent 4968ffa
commit bcb3336
Show file tree

Hide file tree

Showing 7 changed files with 65 additions and 29 deletions.
diff --git a/detecto/utils.py b/detecto/utils.py
@@ -171,7 +171,7 @@ def xml_to_csv(xml_folder, output_file):
     XML file should correspond to an image and contain the image name, image
     size, and the names and bounding boxes of the objects in the image,
     if any. Extraneous data in the XML files will simply be ignored.
-    See :download:`here <_static/example.xml>` for an example XML file.
+    See :download:`here <../_static/example.xml>` for an example XML file.
     For an image labeling tool that produces XML files in this format,
     see `LabelImg <https://github.com/tzutalin/labelImg>`_.
 

diff --git a/docs/api.rst b/docs/api.rst
diff --git a/docs/api/core.rst b/docs/api/core.rst
@@ -0,0 +1,12 @@
+.. _core:
+
+detecto.core
+============
+
+.. automodule:: detecto.core
+   :members:
+   :special-members:
+
+.. autoclass:: detecto.core.Model
+   :members:
+   :special-members: __init__
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,36 @@
+.. _index:
+
+API Documentation
+=================
+
+Click below for documentation specific to each module:
+
+.. toctree::
+   :maxdepth: 1
+
+   core
+   utils
+   visualize
+
+
+Core
+----
+
+The :ref:`core` module contains the central classes of the package: Dataset,
+DataLoader, and Model. These are used to read in a labeled dataset and train
+a functioning object detection model.
+
+
+Utils
+-----
+
+The :ref:`utils` module contains a variety of useful helper functions. With
+it, you can read in images, convert XML files into CSV files, apply standard
+transforms to images, and more.
+
+
+Visualize
+---------
+
+The :ref:`visualize` module is used to display labeled images, plot
+predictions, and run object detection on videos.
diff --git a/docs/api/utils.rst b/docs/api/utils.rst
@@ -0,0 +1,7 @@
+.. _utils:
+
+detecto.utils
+=============
+
+.. automodule:: detecto.utils
+   :members:
diff --git a/docs/api/visualize.rst b/docs/api/visualize.rst
@@ -0,0 +1,7 @@
+.. _visualize:
+
+detecto.visualize
+=================
+
+.. automodule:: detecto.visualize
+   :members:
diff --git a/docs/index.rst b/docs/index.rst
@@ -37,9 +37,10 @@ API Documentation
 =================
 
 .. toctree::
+   :titlesonly:
    :maxdepth: 2
 
-   api
+   api/index
 
 
 Indices and tables