Updated sphinx doco

petercorke · petercorke · commit 464f06580a2b · 2021-07-25T10:36:21.000+10:00
diff --git a/docs/source/2d_line.rst b/docs/source/2d_line.rst
@@ -0,0 +1,6 @@
+2D line
+^^^^^^^
+
+.. autoclass:: spatialmath.geom2d.Line2
+   :members:
+   :undoc-members:
diff --git a/docs/source/2d_polygon.rst b/docs/source/2d_polygon.rst
@@ -0,0 +1,7 @@
+2D polgon
+^^^^^^^^^
+
+.. autoclass:: spatialmath.geom2d.Polygon2
+   :members:
+   :undoc-members:
+   :special-members: __init__, __str__, __len__
diff --git a/docs/source/classes-3d.rst b/docs/source/classes-3d.rst
@@ -1 +1,10 @@
 
+Geometry
+--------
+
+.. automodule:: spatialmath.geom3d
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+   :special-members: __mul__, __rmul__, __eq__, __ne__, __init__, __or__, __xor__
diff --git a/docs/source/func_2d_graphics.rst b/docs/source/func_2d_graphics.rst
@@ -0,0 +1,7 @@
+2D graphics
+===========
+
+2d graphical primitives which build on Matplotlib.
+
+.. automodule:: spatialmath.base.graphics
+   :members: plot_point, plot_homline, plot_box, plot_circle, plot_ellipse, plotvol2
diff --git a/docs/source/func_3d_graphics.rst b/docs/source/func_3d_graphics.rst
@@ -0,0 +1,7 @@
+3D graphics
+===========
+
+3d graphical primitives which build on Matplotlib ``plot_wireframe`` and ``plot_surface``.
+
+.. automodule:: spatialmath.base.graphics
+   :members: plot_cuboid, plot_sphere, plot_ellipsoid, plot_cylinder, plot_cone, plotvol3
diff --git a/docs/source/func_animation.rst b/docs/source/func_animation.rst
@@ -0,0 +1,9 @@
+Animation support
+=================
+
+.. automodule:: spatialmath.base.animate
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :inherited-members:
+   :special-members:
diff --git a/docs/source/func_graphics.rst b/docs/source/func_graphics.rst
@@ -1,16 +1,11 @@
 Graphics and animation
 ======================
 
-.. automodule:: spatialmath.base.animate
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :inherited-members:
-   :special-members:
 
-.. automodule:: spatialmath.base.graphics
-   :members:
-   :undoc-members:
-   :show-inheritance:
-   :inherited-members:
-   :special-members:
+.. toctree::
+   :maxdepth: 2
+
+   func_2d_graphics
+   func_3d_graphics
+   func_animation
+
diff --git a/docs/source/functions.rst b/docs/source/functions.rst
@@ -12,8 +12,9 @@ Function reference
    func_quat
    func_symbolic
    func_vector
-   func_args
    func_graphics
+   func_args
+
 
 
 
diff --git a/docs/source/spatialmath.rst b/docs/source/spatialmath.rst
@@ -52,16 +52,25 @@ Orientation in 3D
    6d_momentum.rst
    6d_inertia.rst
 
-Geometry
---------
+Geometry in 3D
+--------------
+
+.. toctree::
+   :maxdepth: 2
+
+   3d_line
+   3d_plane
+
+Supporting
+----------
 
 .. toctree::
    :maxdepth: 2
 
    3d_quaternion
    3d_dualquaternion
-   3d_plucker
-   3d_plane
+
+---------------
 
 2D-space
 ========
@@ -81,4 +90,13 @@ Orientation in 2D
 .. toctree::
    :maxdepth: 2
 
-   2d_orient_SO2
+   2d_orient_SO2
+
+Geometry in 2D
+--------------
+
+.. toctree::
+   :maxdepth: 2
+
+   2d_line
+   2d_polygon
