Update doc

VIAME · Feb 5, 2018 · 6e23447 · 6e23447
1 parent fdf6f69
commit 6e23447
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 38 deletions.
diff --git a/doc/manuals/index.rst b/doc/manuals/index.rst
@@ -27,20 +27,20 @@ Contents:
 
    example_links/building_viame
    example_links/example_capabilities
+   Core C++/Python Object Types <http://kwiver.readthedocs.io/en/latest/vital/architecture.html>
+   Core Pipelining Architecture <http://kwiver.readthedocs.io/en/latest/sprokit/architecture.html>
+   Basic Processing Nodes <http://kwiver.readthedocs.io/en/latest/arrows/architecture.html>
    example_links/hello_world_pipeline
    example_links/detector_pipelines
-   example_links/detector_training
-   example_links/detection_file_conversions
    example_links/tracking_pipeline
+   example_links/detection_file_conversions
    example_links/measurement_using_stereo
+   example_links/detector_training
    example_links/image_and_video_search
    example_links/using_detectors_in_cxx_code
    example_links/visualizing_detections_in_gui
    example_links/scoring_and_roc_generation
    example_links/external_plugin_creation
-   Core C++/Python Object Types <http://kwiver.readthedocs.io/en/latest/vital/architecture.html>
-   Core Pipelining Architecture <http://kwiver.readthedocs.io/en/latest/sprokit/architecture.html>
-   Basic Processing Nodes <http://kwiver.readthedocs.io/en/latest/arrows/architecture.html>
    KWIVER Manual <http://kwiver.readthedocs.io/en/latest/>
 
 

diff --git a/examples/README.rst b/examples/README.rst
@@ -21,18 +21,18 @@ Measuring Fish Lengths Using Stereo
    :align: center
    :target: https://github.com/Kitware/VIAME/tree/dev/more-doc/examples/measurement_using_stereo
 
-********************************************************
-Image and Appearance Matching for Rapid Model Generation
-********************************************************
+*************************************************
+Image and Video Search for Rapid Model Generation
+*************************************************
 
 .. image:: http://www.viametoolkit.org/wp-content/uploads/2018/01/search_ex.png
    :scale: 50
    :align: center
    :target: https://github.com/Kitware/VIAME/tree/dev/more-doc/examples/image_and_video_search
 
-****************************************
-GUI Visualization and Annotation Support
-****************************************
+*************************************
+GUIs for Visualization and Annotation
+*************************************
 
 .. image:: http://www.viametoolkit.org/wp-content/uploads/2018/02/annotation_example.png
    :scale: 50

diff --git a/examples/building_viame/README.rst b/examples/building_viame/README.rst
@@ -10,15 +10,11 @@
 Building VIAME From Source
 ==========================
 
-| See the platform-specific guides below, though the process is similar for each.
-|
-| This document corresponds to the example located online at:
-|
-| https://github.com/Kitware/VIAME/tree/master/examples/building_viame
-|
-| and also to the following directory in your VIAME installation:
-|
-| [viame-install]/examples/building_viame
+See the platform-specific guides below, though the process is similar for each.
+This document corresponds to the example located online at:
+https://github.com/Kitware/VIAME/tree/master/examples/building_viame
+and also to the following directory in your VIAME installation:
+[viame-install]/examples/building_viame.
 
 
 *****************

diff --git a/examples/hello_world_pipeline/README.rst b/examples/hello_world_pipeline/README.rst
@@ -1,9 +1,17 @@
 
-===================
-New Module Creation
-===================
-
-Example c++ plugin
+============================
+New Module Creation Examples
+============================
+
+See the platform-specific guides below, though the process is similar for each.
+This document corresponds to the example located online at:
+https://github.com/Kitware/VIAME/tree/master/examples/building_viame
+and also to the following directory in your VIAME installation:
+[viame-install]/examples/building_viame.
+
+**********************************
+Example C++ Object Detector Plugin
+**********************************
 
 A new detector plugin is added by creating a class that implements the
 kwiver::vital::algo::image_object_detector interface. This interface

diff --git a/examples/measurement_using_stereo/README.rst b/examples/measurement_using_stereo/README.rst
@@ -7,4 +7,6 @@ Size Measurement Using Stereo Cameras
    :scale: 60
    :align: center
 
-`Coming Soon <https://github.com/Kitware/VIAME/pull/25`_
+`Coming Soon`_
+
+.. _Coming Soon: https://github.com/Kitware/VIAME/pull/25
diff --git a/examples/tracking_pipelines/README.rst b/examples/tracking_pipelines/README.rst
@@ -1,16 +1,12 @@
 
-===============
-Object Tracking
-===============
+=======================
+Object Tracking Example
+=======================
 
-This folder contains a simple, but efficient, object tracking example.
+.. image:: http://www.viametoolkit.org/wp-content/uploads/2018/02/computed_track_example.png
+   :scale: 60
+   :align: center
 
-A better tracker (based on 'tracking the untrackable') will be available
-shortly.
-
-The example currently requires:
-
-  (a) A VIAME build with VIAME_ENABLE_BURNOUT and VIAME_ENABLE_VXL turned on
-
-It's inoperable at the moment but will be updated shortly.
+`Coming Soon`_
 
+.. _Coming Soon: https://github.com/Kitware/VIAME/pull/30