[DOC] Python API add ROS2 package info

sarthou · Jan 15, 2024 · ba491d0 · ba491d0
1 parent 555dbff
commit ba491d0
Show file tree

Hide file tree

Showing 22 changed files with 95 additions and 43 deletions.
diff --git a/docs/python_API/ActionClient.html b/docs/python_API/ActionClient.html
@@ -123,8 +123,9 @@ <h1 class="title">ActionClient Class</h1>
         <div class="table">
           <table class="alignedsummary">
             <tbody>
-              <tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span>
-              </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="ClientBase.html">ClientBase</a></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="ClientBase.html">ClientBase</a></td></tr>
             </tbody>
           </table>
         </div>

diff --git a/docs/python_API/ClassClient.html b/docs/python_API/ClassClient.html
@@ -122,8 +122,12 @@ <h1 class="title">ClassClient Class</h1>
         <p>The ClassClient class provides a ROS service abstraction for classes exploration. <a href="#details">More...</a></p>
         <div class="table">
           <table class="alignedsummary">
-          <tbody><tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span>
-          </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyClient.html">OntologyClient</a></td></tr></tbody></table>
+            <tbody>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyClient.html">OntologyClient</a></td></tr>
+            </tbody>
+          </table>
         </div>
 
         <a name="methods"></a>

diff --git a/docs/python_API/ClassIndexClient.html b/docs/python_API/ClassIndexClient.html
@@ -122,8 +122,12 @@ <h1 class="title">ClassIndexClient Class</h1>
         <p>The ClassIndexClient class provides a ROS service abstraction for classes exploration. <a href="#details">More...</a></p>
         <div class="table">
           <table class="alignedsummary">
-          <tbody><tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span>
-          </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyIndexClient.html">OntologyIndexClient</a></td></tr></tbody></table>
+            <tbody>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyIndexClient.html">OntologyIndexClient</a></td></tr>
+            </tbody>
+          </table>
         </div>
 
         <a name="methods"></a>

diff --git a/docs/python_API/ClientBase.html b/docs/python_API/ClientBase.html
@@ -121,8 +121,12 @@ <h1 class="title">ClientBase Class</h1>
         <p>The ClientBase class provides a common ROS service abstraction. <a href="#details">More...</a></p>
         <div class="table">
           <table class="alignedsummary">
-          <tbody><tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span>
-          </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <a href="OntologyClient.html">OntologyClient</a>, <a href="ActionClient.html">ActionClient</a>, <a href="ManagerClient.html">ManagerClient</a>, <a href="ReasonerClient.html">ReasonerClient</a></td></tr></tbody></table>
+            <tbody>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <a href="OntologyClient.html">OntologyClient</a>, <a href="ActionClient.html">ActionClient</a>, <a href="ManagerClient.html">ManagerClient</a>, <a href="ReasonerClient.html">ReasonerClient</a></td></tr>
+            </tbody>
+          </table>
         </div>
 
         <a name="methods"></a>

diff --git a/docs/python_API/ClientBaseIndex.html b/docs/python_API/ClientBaseIndex.html
@@ -121,8 +121,12 @@ <h1 class="title">ClientBaseIndex Class</h1>
         <p>The ClientBaseIndex class provides a common ROS service abstraction. <a href="#details">More...</a></p>
         <div class="table">
           <table class="alignedsummary">
-          <tbody><tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span>
-          </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <a href="OntologyIndexClient.html">OntologyIndexClient</a></td></tr></tbody></table>
+            <tbody>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <a href="OntologyIndexClient.html">OntologyIndexClient</a></td></tr>
+            </tbody>
+          </table>
         </div>
 
         <a name="methods"></a>

diff --git a/docs/python_API/ConversionClient.html b/docs/python_API/ConversionClient.html
@@ -121,9 +121,10 @@ <h1 class="title">ConversionClient Class</h1>
         <p>The ConversionClient class provides an abstraction to the ontologenius conversion ROS services. <a href="#details">More...</a></p>
         <div class="table">
           <table class="alignedsummary">
-          <tbody>
-            <tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
-          </tbody>
+            <tbody>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
+            </tbody>
           </table>
         </div>
 

diff --git a/docs/python_API/DataPropertyClient.html b/docs/python_API/DataPropertyClient.html
@@ -122,8 +122,12 @@ <h1 class="title">DataPropertyClient Class</h1>
         <p>The DataPropertyClient class provides a ROS service abstraction for data properties exploration. <a href="#details">More...</a></p>
         <div class="table">
           <table class="alignedsummary">
-          <tbody><tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span>
-          </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyClient.html">OntologyClient</a></td></tr></tbody></table>
+            <tbody>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyClient.html">OntologyClient</a></td></tr>
+              </tbody>
+          </table>
         </div>
 
         <a name="methods"></a>

diff --git a/docs/python_API/DataPropertyIndexClient.html b/docs/python_API/DataPropertyIndexClient.html
@@ -122,8 +122,12 @@ <h1 class="title">DataPropertyIndexClient Class</h1>
         <p>The DataPropertyIndexClient class provides a ROS service abstraction for data properties exploration. <a href="#details">More...</a></p>
         <div class="table">
           <table class="alignedsummary">
-          <tbody><tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span>
-          </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyIndexClient.html">OntologyIndexClient</a></td></tr></tbody></table>
+            <tbody>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyIndexClient.html">OntologyIndexClient</a></td></tr>
+            </tbody>
+          </table>
         </div>
 
         <a name="methods"></a>

diff --git a/docs/python_API/FeederPublisher.html b/docs/python_API/FeederPublisher.html
@@ -122,7 +122,8 @@ <h1 class="title">FeederPublisher Class</h1>
         <div class="table">
           <table class="alignedsummary">
             <tbody>
-              <tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
             </tbody>
           </table>
         </div>

diff --git a/docs/python_API/IndividualClient.html b/docs/python_API/IndividualClient.html
@@ -122,8 +122,12 @@ <h1 class="title">IndividualClient Class</h1>
         <p>The IndividualClient class provides a ROS service abstraction for individuals exploration. <a href="#details">More...</a></p>
         <div class="table">
           <table class="alignedsummary">
-          <tbody><tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span>
-          </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyClient.html">OntologyClient</a></td></tr></tbody></table>
+            <tbody>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyClient.html">OntologyClient</a></td></tr>
+            </tbody>
+          </table>
         </div>
 
         <a name="methods"></a>

diff --git a/docs/python_API/IndividualIndexClient.html b/docs/python_API/IndividualIndexClient.html
@@ -122,8 +122,12 @@ <h1 class="title">IndividualIndexClient Class</h1>
         <p>The IndividualIndexClient class provides a ROS service abstraction for individuals exploration. <a href="#details">More...</a></p>
         <div class="table">
           <table class="alignedsummary">
-          <tbody><tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span>
-          </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyIndexClient.html">OntologyIndexClient</a></td></tr></tbody></table>
+            <tbody>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyIndexClient.html">OntologyIndexClient</a></td></tr>
+            </tbody>
+          </table>
         </div>
 
         <a name="methods"></a>

diff --git a/docs/python_API/ManagerClient.html b/docs/python_API/ManagerClient.html
@@ -123,9 +123,10 @@ <h1 class="title">ManagerClient Class</h1>
         <div class="table">
           <table class="alignedsummary">
             <tbody>
-              <tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span>
-              </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="ClientBase.html">ClientBase</a></td></tr>
-              </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <a href="OntologiesManipulator.html">OntologiesManipulator</a></td></tr></tbody></table>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="ClientBase.html">ClientBase</a></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <a href="OntologiesManipulator.html">OntologiesManipulator</a></td></tr>
             </tbody>
           </table>
         </div>

diff --git a/docs/python_API/ObjectPropertyClient.html b/docs/python_API/ObjectPropertyClient.html
@@ -122,8 +122,12 @@ <h1 class="title">ObjectPropertyClient Class</h1>
         <p>The ObjectPropertyClient class provides a ROS service abstraction for object properties exploration. <a href="#details">More...</a></p>
         <div class="table">
           <table class="alignedsummary">
-          <tbody><tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span>
-          </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyClient.html">OntologyClient</a></td></tr></tbody></table>
+            <tbody>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyClient.html">OntologyClient</a></td></tr>
+            </tbody>
+          </table>
         </div>
 
         <a name="methods"></a>

diff --git a/docs/python_API/ObjectPropertyIndexClient.html b/docs/python_API/ObjectPropertyIndexClient.html
@@ -122,8 +122,12 @@ <h1 class="title">ObjectPropertyIndexClient Class</h1>
         <p>The ObjectPropertyIndexClient class provides a ROS service abstraction for object properties exploration. <a href="#details">More...</a></p>
         <div class="table">
           <table class="alignedsummary">
-          <tbody><tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span>
-          </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyIndexClient.html">OntologyIndexClient</a></td></tr></tbody></table>
+            <tbody>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="OntologyIndexClient.html">OntologyIndexClient</a></td></tr>
+            </tbody>
+          </table>
         </div>
 
         <a name="methods"></a>

diff --git a/docs/python_API/OntologiesManipulator.html b/docs/python_API/OntologiesManipulator.html
@@ -123,8 +123,9 @@ <h1 class="title">OntologiesManipulator Class</h1>
         <div class="table">
           <table class="alignedsummary">
             <tbody>
-              <tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span>
-              </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="ManagerClient.html">ManagerClient</a></td></tr></tbody></table>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="ManagerClient.html">ManagerClient</a></td></tr>
             </tbody>
           </table>
         </div>

diff --git a/docs/python_API/OntologyClient.html b/docs/python_API/OntologyClient.html
@@ -123,9 +123,10 @@ <h1 class="title">OntologyClient Class</h1>
         <div class="table">
           <table class="alignedsummary">
             <tbody>
-              <tr><td class="memItemLeft rightAlign topAlign"> Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span>
-              </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="ClientBase.html">ClientBase</a></td></tr>
-            </td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <a href="IndividualClient.html">IndividualClient</a>, <a href="ClassClient.html">ClassClient</a>, <a href="DataPropertyClient.html">DataPropertyClient</a>, <a href="ObjectPropertyClient.html">ObjectPropertyClient</a></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros1 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontologenius</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Ros2 Package:</td><td class="memItemRight bottomAlign"> <span class="preprocessor">ontopy</span></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="ClientBase.html">ClientBase</a></td></tr>
+              <tr><td class="memItemLeft rightAlign topAlign"> Inherited By:</td><td class="memItemRight bottomAlign"> <a href="IndividualClient.html">IndividualClient</a>, <a href="ClassClient.html">ClassClient</a>, <a href="DataPropertyClient.html">DataPropertyClient</a>, <a href="ObjectPropertyClient.html">ObjectPropertyClient</a></td></tr>
             </tbody>
           </table>
         </div>