Skip to content

Commit

Permalink
docs clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
yijiangh committed Mar 8, 2022
1 parent b5065a0 commit 16f807f
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 13 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0

Known Unresolved Issues
-----------------------

- `get_body_collision_vertices` does not support cloned body now. We don't have a good way to do catch-throw for this now.
- Cloning body from an already cloned body introduces unexpected result (visual or collision data erased etc).

Expand All @@ -27,7 +28,7 @@ Unreleased

**Changed**
- Apply `HideOutput` to pybullet IK error printouts in `inverse_kinematics_helper`
- ``motion_planners`` module up-to-date with `commit e6f23053e<https://github.com/caelan/motion-planners/commit/e6f23053e441af091b898b7f56c6fee48223be48>`_.
- ``motion_planners`` module up-to-date with commit `e6f23053e <https://github.com/caelan/motion-planners/commit/e6f23053e441af091b898b7f56c6fee48223be48>`_.
- Changed the mesh reading procedure in `vertices_from_data` from `pp.read_obj` to `meshio.read`. This fixes #9.
- `smooth_path`'s `max_iterations` argument changed to `max_smooth_iterations`
- 'set_color' defaulted to set the color of all the links of body.
Expand Down
8 changes: 4 additions & 4 deletions src/pybullet_planning/interfaces/geometry/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@
AABB
Bounding box operations
-----------------------
.. currentmodule:: pybullet_planning.interfaces.geometry.bounding_box
----------------------------------
.. autosummary::
:toctree: generated/
Expand All @@ -31,9 +29,11 @@
"""

from __future__ import absolute_import

from .bounding_box import *
from .mesh import *
from .polygon import *
from .bounding_box import *
from .pointcloud import *
from .camera import *

Expand Down
7 changes: 2 additions & 5 deletions src/pybullet_planning/interfaces/geometry/bounding_box.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,9 @@
#####################################
# Bounding box

# axis-aligned bounding box: https://en.wikipedia.org/wiki/Bounding_volume
# Notice that the world-axis is used here. We don't have support for OOBB (using the object's local coordinate system)?
AABB = namedtuple('AABB', ['lower', 'upper'])
"""axis-aligned bounding box: https://en.wikipedia.org/wiki/Bounding_volume
Notice that the world-axis is used here. We don't have support for OOBB (using the object's local coordinate system)?
"""

def aabb_from_points(points):
return AABB(np.min(points, axis=0), np.max(points, axis=0))
Expand Down
3 changes: 1 addition & 2 deletions src/pybullet_planning/motion_planners/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@
to be flexible and independent of simulation platforms. `pybullet_planning` includes
this package as a built-in component as it is frequently used.
We are now up-to-date with commit `e6f23053e <https://github.com/caelan/motion-planners/commit/e6f23053e441af091b898b7f56c6fee48223be48>`_
of ``motion-planners``.
We are now up-to-date with commit `e6f23053e <https://github.com/caelan/motion-planners/commit/e6f23053e441af091b898b7f56c6fee48223be48>`_ of ``motion-planners``.
Sampling-based:
Expand Down
2 changes: 1 addition & 1 deletion tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ def release(ctx, release_type, bump_version=False):
raise Exit('The release type parameter is invalid.\nMust be one of: major, minor, patch')

# Run checks
ctx.run('invoke check test docs')
ctx.run('invoke check test') # docs

# Bump version and git tag it
if bump_version:
Expand Down

0 comments on commit 16f807f

Please sign in to comment.