Skip to content

Commit

Permalink
changed literalincludes to remoteliteralincludes (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
steviedale committed Jun 4, 2021
1 parent 1050f58 commit 28d98d6
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 60 deletions.
28 changes: 14 additions & 14 deletions _source/core/packages/tesseract_collision_doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Features
Discrete Collision Checker Example
==================================

.. literalinclude:: /../tesseract_collision/examples/box_box_example.cpp
.. rli:: https://raw.githubusercontent.com/ros-industrial-consortium/tesseract/master/tesseract_collision/examples/box_box_example.cpp
:language: c++

You can find this example `here <https://github.com/ros-industrial-consortium/tesseract/blob/master/tesseract_collision/examples/box_box_example.cpp>`_.
Expand All @@ -39,7 +39,7 @@ Example Explanation
Create Contact Checker
^^^^^^^^^^^^^^^^^^^^^^

.. literalinclude:: /../tesseract_collision/examples/box_box_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_collision/examples/box_box_example.cpp
:language: c++
:start-after: // documentation:start:1:
:end-before: // documentation:end:1:
Expand Down Expand Up @@ -67,7 +67,7 @@ Add Collision Objects to Contact Checker
Add a collision object in a enabled state
"""""""""""""""""""""""""""""""""""""""""

.. literalinclude:: /../tesseract_collision/examples/box_box_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_collision/examples/box_box_example.cpp
:language: c++
:start-after: // documentation:start:2:
:end-before: // documentation:end:2:
Expand All @@ -78,46 +78,46 @@ Add a collision object in a enabled state
Add collision object in a disabled state
""""""""""""""""""""""""""""""""""""""""

.. literalinclude:: /../tesseract_collision/examples/box_box_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_collision/examples/box_box_example.cpp
:language: c++
:start-after: // documentation:start:3:
:end-before: // documentation:end:3:

Create convex hull from mesh file
"""""""""""""""""""""""""""""""""

.. literalinclude:: /../tesseract_collision/examples/box_box_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_collision/examples/box_box_example.cpp
:language: c++
:start-after: documentation:start:4:
:end-before: documentation:end:4:

Add convex hull collision object
""""""""""""""""""""""""""""""""
.. literalinclude:: /../tesseract_collision/examples/box_box_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_collision/examples/box_box_example.cpp
:language: c++
:start-after: documentation:start:5:
:end-before: documentation:end:5:

Set the active collision objects
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. literalinclude:: /../tesseract_collision/examples/box_box_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_collision/examples/box_box_example.cpp
:language: c++
:start-after: documentation:start:6:
:end-before: documentation:end:6:

Set the contact distance threshold
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. literalinclude:: /../tesseract_collision/examples/box_box_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_collision/examples/box_box_example.cpp
:language: c++
:start-after: documentation:start:7:
:end-before: documentation:end:7:

Set the collision object's transform
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. literalinclude:: /../tesseract_collision/examples/box_box_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_collision/examples/box_box_example.cpp
:language: c++
:start-after: documentation:start:8:
:end-before: documentation:end:8:
Expand All @@ -129,15 +129,15 @@ Perform collision check

One object is inside another object

.. literalinclude:: /../tesseract_collision/examples/box_box_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_collision/examples/box_box_example.cpp
:language: c++
:start-after: documentation:start:9:
:end-before: documentation:end:9:

Set the collision object's transform
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. literalinclude:: /../tesseract_collision/examples/box_box_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_collision/examples/box_box_example.cpp
:language: c++
:start-after: documentation:start:10:
:end-before: documentation:end:10:
Expand All @@ -149,15 +149,15 @@ Perform collision check

The objects are outside the contact threshold

.. literalinclude:: /../tesseract_collision/examples/box_box_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_collision/examples/box_box_example.cpp
:language: c++
:start-after: documentation:start:11:
:end-before: documentation:end:11:

Change contact distance threshold
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. literalinclude:: /../tesseract_collision/examples/box_box_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_collision/examples/box_box_example.cpp
:language: c++
:start-after: // documentation:start:12:
:end-before: // documentation:end:12:
Expand All @@ -170,7 +170,7 @@ Perform collision check

The objects are inside the contact threshold

.. literalinclude:: /../tesseract_collision/examples/box_box_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_collision/examples/box_box_example.cpp
:language: c++
:start-after: // documentation:start:13:
:end-before: // documentation:end:13:
Expand Down
22 changes: 11 additions & 11 deletions _source/core/packages/tesseract_geometry_doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,57 +27,57 @@ Features
Creating Geometry Shapes
========================

.. literalinclude:: ../../../../tesseract_geometry/examples/create_geometries_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_geometry/examples/create_geometries_example.cpp


Example Explanation
-------------------

#. Create a box.

.. literalinclude:: ../../../../tesseract_geometry/examples/create_geometries_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_geometry/examples/create_geometries_example.cpp
:language: c++
:start-after: // Shape Box
:end-before: // Shape Cone

#. Create a cone.

.. literalinclude:: ../../../../tesseract_geometry/examples/create_geometries_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_geometry/examples/create_geometries_example.cpp
:language: c++
:start-after: // Shape Cone
:end-before: // Shape Capsule

#. Create a capsule.

.. literalinclude:: ../../../../tesseract_geometry/examples/create_geometries_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_geometry/examples/create_geometries_example.cpp
:language: c++
:start-after: // Shape Capsule
:end-before: // Shape Cylinder

#. Create a cylinder.

.. literalinclude:: ../../../../tesseract_geometry/examples/create_geometries_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_geometry/examples/create_geometries_example.cpp
:language: c++
:start-after: // Shape Cylinder
:end-before: // Shape Plane

#. Create a plane.

.. literalinclude:: ../../../../tesseract_geometry/examples/create_geometries_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_geometry/examples/create_geometries_example.cpp
:language: c++
:start-after: // Shape Plane
:end-before: // Shape Sphere

#. Create a sphere.

.. literalinclude:: ../../../../tesseract_geometry/examples/create_geometries_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_geometry/examples/create_geometries_example.cpp
:language: c++
:start-after: // Shape Sphere
:end-before: // Manually create mesh

#. Create a mesh.

.. literalinclude:: ../../../../tesseract_geometry/examples/create_geometries_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_geometry/examples/create_geometries_example.cpp
:language: c++
:start-after: // Manually create mesh
:end-before: // Manually create signed distance field mesh
Expand All @@ -92,7 +92,7 @@ Example Explanation

This should be the same as a mesh, but when interperated as the collision object it will be encoded as a signed distance field.

.. literalinclude:: ../../../../tesseract_geometry/examples/create_geometries_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_geometry/examples/create_geometries_example.cpp
:language: c++
:start-after: // Manually create signed distance field mesh
:end-before: // Manually create convex mesh
Expand All @@ -107,7 +107,7 @@ Example Explanation

This expects the data to already represent a convex mesh. If yours does not load as a mesh and then use tesseract utility to convert to a convex mesh.

.. literalinclude:: ../../../../tesseract_geometry/examples/create_geometries_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_geometry/examples/create_geometries_example.cpp
:language: c++
:start-after: // Manually create convex mesh
:end-before: // Create an octree
Expand All @@ -118,7 +118,7 @@ Example Explanation

#. Create an octree.

.. literalinclude:: ../../../../tesseract_geometry/examples/create_geometries_example.cpp
.. rli:: https://raw.githubusercontent.com/steviedale/tesseract/update/tesseract_documentation/tesseract_geometry/examples/create_geometries_example.cpp
:language: c++
:start-after: // Create an octree
:end-before: }
Expand Down

0 comments on commit 28d98d6

Please sign in to comment.