Group and Document modules (#131)

* organize pathfinders into separate directory, modularize captain

* organize lidars into their own package

* update rst files to reflect directory changes

* fix import issues related to lidar/pathfinder packages, implement unimplemented method in Pathfinder

* wrap up merge conflicts

* Properly close resources in `rover.py`

docs/unified_frameworks.bridge.rst

@@ -4,14 +4,6 @@ unified\_frameworks.bridge package
 Submodules
 ----------
 
-unified\_frameworks.bridge.acync\_demos module
-----------------------------------------------
-
-.. automodule:: unified_frameworks.bridge.acync_demos
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 unified\_frameworks.bridge.client\_side module
 ----------------------------------------------
 

docs/unified_frameworks.pathfinders.rst

@@ -0,0 +1,53 @@
+unified\_frameworks.pathfinders package
+=======================================
+
+Submodules
+----------
+
+unified\_frameworks.pathfinders.NavigatorClass module
+-----------------------------------------------------
+
+.. automodule:: unified_frameworks.pathfinders.NavigatorClass
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+unified\_frameworks.pathfinders.a\_star\_navigator module
+---------------------------------------------------------
+
+.. automodule:: unified_frameworks.pathfinders.a_star_navigator
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+unified\_frameworks.pathfinders.pathfinder module
+-------------------------------------------------
+
+.. automodule:: unified_frameworks.pathfinders.pathfinder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+unified\_frameworks.pathfinders.rapid\_random\_tree module
+----------------------------------------------------------
+
+.. automodule:: unified_frameworks.pathfinders.rapid_random_tree
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+unified\_frameworks.pathfinders.straight\_shot module
+-----------------------------------------------------
+
+.. automodule:: unified_frameworks.pathfinders.straight_shot
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: unified_frameworks.pathfinders
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/unified_frameworks.rst

@@ -8,27 +8,12 @@ Subpackages
    :maxdepth: 4
 
    unified_frameworks.bridge
+   unified_frameworks.pathfinders
    unified_frameworks.sensor_array
 
 Submodules
 ----------
 
-unified\_frameworks.NavigatorClass module
------------------------------------------
-
-.. automodule:: unified_frameworks.NavigatorClass
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-unified\_frameworks.a\_star\_navigator module
----------------------------------------------
-
-.. automodule:: unified_frameworks.a_star_navigator
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 unified\_frameworks.captain module
 ----------------------------------
 
@@ -37,14 +22,6 @@ unified\_frameworks.captain module
    :undoc-members:
    :show-inheritance:
 
-unified\_frameworks.pathfinder module
--------------------------------------
-
-.. automodule:: unified_frameworks.pathfinder
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 unified\_frameworks.pathfinder\_visualizer module
 -------------------------------------------------
 
@@ -53,22 +30,6 @@ unified\_frameworks.pathfinder\_visualizer module
    :undoc-members:
    :show-inheritance:
 
-unified\_frameworks.rapid\_random\_tree module
-----------------------------------------------
-
-.. automodule:: unified_frameworks.rapid_random_tree
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-unified\_frameworks.straight\_shot module
------------------------------------------
-
-.. automodule:: unified_frameworks.straight_shot
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 unified\_frameworks.unified\_utils module
 -----------------------------------------
 

docs/unified_frameworks.sensor_array.lidar.rst

@@ -0,0 +1,61 @@
+unified\_frameworks.sensor\_array.lidar package
+===============================================
+
+Submodules
+----------
+
+unified\_frameworks.sensor\_array.lidar.LidarClass module
+---------------------------------------------------------
+
+.. automodule:: unified_frameworks.sensor_array.lidar.LidarClass
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+unified\_frameworks.sensor\_array.lidar.actual\_lidar module
+------------------------------------------------------------
+
+.. automodule:: unified_frameworks.sensor_array.lidar.actual_lidar
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+unified\_frameworks.sensor\_array.lidar.bridge\_lidar module
+------------------------------------------------------------
+
+.. automodule:: unified_frameworks.sensor_array.lidar.bridge_lidar
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+unified\_frameworks.sensor\_array.lidar.fake\_lidar module
+----------------------------------------------------------
+
+.. automodule:: unified_frameworks.sensor_array.lidar.fake_lidar
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+unified\_frameworks.sensor\_array.lidar.lidar module
+----------------------------------------------------
+
+.. automodule:: unified_frameworks.sensor_array.lidar.lidar
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+unified\_frameworks.sensor\_array.lidar.lidar\_visualizer module
+----------------------------------------------------------------
+
+.. automodule:: unified_frameworks.sensor_array.lidar.lidar_visualizer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: unified_frameworks.sensor_array.lidar
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/unified_frameworks.sensor_array.rst

@@ -8,18 +8,11 @@ Subpackages
    :maxdepth: 4
 
    unified_frameworks.sensor_array.gps_compass
+   unified_frameworks.sensor_array.lidar
 
 Submodules
 ----------
 
-unified\_frameworks.sensor\_array.LidarClass module
----------------------------------------------------
-
-.. automodule:: unified_frameworks.sensor_array.LidarClass
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 unified\_frameworks.sensor\_array.actual\_gps\_test module
 ----------------------------------------------------------
 
@@ -28,14 +21,6 @@ unified\_frameworks.sensor\_array.actual\_gps\_test module
    :undoc-members:
    :show-inheritance:
 
-unified\_frameworks.sensor\_array.actual\_lidar module
-------------------------------------------------------
-
-.. automodule:: unified_frameworks.sensor_array.actual_lidar
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 unified\_frameworks.sensor\_array.bridge\_gps module
 ----------------------------------------------------
 
@@ -44,54 +29,6 @@ unified\_frameworks.sensor\_array.bridge\_gps module
    :undoc-members:
    :show-inheritance:
 
-unified\_frameworks.sensor\_array.bridge\_lidar module
-------------------------------------------------------
-
-.. automodule:: unified_frameworks.sensor_array.bridge_lidar
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-unified\_frameworks.sensor\_array.client\_bridge\_lidar module
---------------------------------------------------------------
-
-.. automodule:: unified_frameworks.sensor_array.client_bridge_lidar
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-unified\_frameworks.sensor\_array.client\_lidar module
-------------------------------------------------------
-
-.. automodule:: unified_frameworks.sensor_array.client_lidar
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-unified\_frameworks.sensor\_array.fake\_lidar module
-----------------------------------------------------
-
-.. automodule:: unified_frameworks.sensor_array.fake_lidar
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-unified\_frameworks.sensor\_array.lidar module
-----------------------------------------------
-
-.. automodule:: unified_frameworks.sensor_array.lidar
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-unified\_frameworks.sensor\_array.lidar\_visualizer module
-----------------------------------------------------------
-
-.. automodule:: unified_frameworks.sensor_array.lidar_visualizer
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 unified\_frameworks.sensor\_array.server\_gps module
 ----------------------------------------------------
 
@@ -100,30 +37,6 @@ unified\_frameworks.sensor\_array.server\_gps module
    :undoc-members:
    :show-inheritance:
 
-unified\_frameworks.sensor\_array.server\_lidar module
-------------------------------------------------------
-
-.. automodule:: unified_frameworks.sensor_array.server_lidar
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-unified\_frameworks.sensor\_array.websocket\_client module
-----------------------------------------------------------
-
-.. automodule:: unified_frameworks.sensor_array.websocket_client
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-unified\_frameworks.sensor\_array.websocket\_server module
-----------------------------------------------------------
-
-.. automodule:: unified_frameworks.sensor_array.websocket_server
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 Module contents
 ---------------