Fix a bunch of Sphinx warnings

AUTHORS.rst

@@ -22,7 +22,8 @@ If you use COMPAS FAB in a project, please use the following citation:
             Lytle, B. and
             Huang, Y. and
             Kasirer, C. and
-            Bruun, E.
+            Bruun, E. and
+            Leung, P.Y.V.
             },
         howpublished={https://github.com/compas-dev/compas\_fab/},
         note={Gramazio Kohler Research, ETH Z\"{u}rich},
@@ -49,4 +50,5 @@ Authors
 * Yijiang Huang <[email protected]> `@yijiangh <https://github.com/yijiangh>`_
 * Chen Kasirer <[email protected]> `@chenkasirer <https://github.com/chenkasirer>`_
 * Edvard Bruun <[email protected]> `@ebruun <https://github.com/ebruun>`_
+* Victor Pok Yin Leung <[email protected]> `@yck011522 <https://github.com/yck011522>`_
 

CHANGELOG.md

@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * `Robot` now inherit from `compas.data.Data`
 * `RobotSemantics` now inherit from `compas.data.Data`
 * `Tool` now inherit from `compas.data.Data`
+* Fixed a number of Sphinx warnings
 
 ### Removed
 

docs/backends/pybullet.rst

@@ -15,13 +15,13 @@ is based on a client-server architecture, there is no need to spin up any Docker
 containers to run the server.  This, along with its speed, may make PyBullet a
 preferable backend for COMPAS_FAB.  However, it, alone, does not provide motion
 planning functionality.  PyBullet is also not compatible with IronPython. Hence to use
-it with Rhinoceros and Grasshopper it must be invoked through the 
+it with Rhinoceros and Grasshopper it must be invoked through the
 :mod:`compas.rpc` module.
 
 Next Steps
 ==========
 
-* :ref:`Tutorial: COMPAS Robots <compas:robots>`
+* `Tutorial: COMPAS Robots <https://compas.dev/compas/1.17.9/tutorial/robots.html>`__
 * :ref:`Examples: Description models <examples_description_models>`
 * :ref:`Examples: PyBullet Backend <examples_pybullet>`
 * :ref:`COMPAS FAB API Reference <reference>`

docs/backends/ros.rst

@@ -154,7 +154,7 @@ Check :ref:`the following page <backends_gui>` for more details.
 Next Steps
 ==========
 
-* :ref:`Tutorial: COMPAS Robots <compas:robots>`
+* `Tutorial: COMPAS Robots <https://compas.dev/compas/1.17.9/tutorial/robots.html>`__
 * :ref:`Examples: Description models <examples_description_models>`
 * :ref:`Examples: ROS Backend <examples_ros>`
 * :ref:`COMPAS FAB API Reference <reference>`

docs/examples/07_reachability_map.rst

@@ -1,4 +1,4 @@
-.. _examples_kinematics:
+.. _examples_reachability_map:
 
 *******************************************************************************
 Planning: Reachability Map

docs/examples/07_reachability_map/03_rp_2D.rst

@@ -47,7 +47,7 @@ The visualization of the results in Rhino/GH looks different than in Example 01,
     :class: figure-img img-fluid
 
 
-`Link to full script <files/02_example_2D_deviation_vectors.py>`_
+`Link to full script <files/02_example_2D_deviation_vectors.py>`__
 
 
 
@@ -120,4 +120,4 @@ best score, returning the score and the index:
     :class: figure-img img-fluid
 
 
-`Link to full script <files/03_example_2D_sphere_points.py>`_
+`Link to full script <files/03_example_2D_sphere_points.py>`__

src/compas_fab/backends/kinematics/analytical_inverse_kinematics.py

@@ -56,10 +56,8 @@ def inverse_kinematics(self, robot, frame_WCF, start_configuration=None, group=N
         options: dict
             Dictionary containing the following key-value pairs:
             - ``"solver"``: (:obj:`str`) The solver to use to calculate IK.
-            - ``"check_collision"``: (:obj:`str`, optional ) When ``True``, checks
-                if the robot is in collision. Defaults to ``False``.
-            - ``"keep_order"``: (:obj:`str`, optional ) When ``False``, removes the
-                ``None``- solutions. Defaults to ``False``.
+            - ``"check_collision"``: (:obj:`str`, optional ) When ``True``, checks if the robot is in collision. Defaults to ``False``.
+            - ``"keep_order"``: (:obj:`str`, optional ) When ``False``, removes the ``None``- solutions. Defaults to ``False``.
 
         Yields
         -------

src/compas_fab/backends/pybullet/backend_features/pybullet_add_attached_collision_mesh.py

@@ -43,15 +43,15 @@ def add_attached_collision_mesh(self, attached_collision_mesh, options=None):
               to which the object should be attached.
             - ``"mass"``: (:obj:`float`) The mass of the attached collision
               object.  Defaults to ``1``.
-            - ``inertia"``: (:obj:`list`) The elements of the inertia matrix
+            - ``"inertia"``: (:obj:`list`) The elements of the inertia matrix
               of the attached collision object given as
               ``[<ixx>, <ixy>, <ixz>, <iyy>, <iyz>, <izz>]``.  Defaults to
               ``[1., 0., 0., 1., 0., 1.]``.
             - ``"inertial_origin"``: (:class:`compas.geometry.Frame`) This is
               the pose of the inertial reference frame, relative to the link
               reference frame. Defaults to
               :class:`compas.geometry.Frame.worldXY()`.
-            - ``"collision_origin"``(:class:`compas.geometry.Frame`) This is
+            - ``"collision_origin"``: (:class:`compas.geometry.Frame`) This is
               the pose of the collision reference frame, relative to the link
               reference frame. Defaults to
               :class:`compas.geometry.Frame.worldXY()`.

src/compas_fab/robots/reachability_map/reachability_map.py

@@ -26,8 +26,8 @@ class ReachabilityMap(Data):
         The shape of the frames array
 
 
-    Links
-    -----
+    References
+    ----------
     http://wiki.ros.org/reuleaux
     """
 

src/compas_fab/robots/trajectory.py

@@ -245,8 +245,8 @@ def merged(self, other):
 class Trajectory(Data):
     """Base trajectory class.
 
-    Attribute
-    ---------
+    Attributes
+    ----------
     planning_time : :obj:`float`
         Amount of time it took to complete the motion plan
     """