Skip to content

Commit 1fbd7bc

Browse files
Merge pull request #44 from AbdelrhmanBassiouny/main
Fix figures in Doc
2 parents d43537f + c4119e9 commit 1fbd7bc

3 files changed

Lines changed: 19 additions & 4 deletions

File tree

-2.79 KB
Loading

doc/world_reasoner.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,12 @@ shell. Maybe you see a mistake and not all the currently detected drawers are ac
6969
results. To start writing your rule, just type `%edit` in the Ipython terminal as shown the image bellow, or if using
7070
the GUI just press the `Edit` button.
7171

72-
<img src="images/write_edit_in_ipython.png" alt="Write %edit in Ipython" width="600"/>
72+
```{figure} images/write_edit_in_ipython.png
73+
---
74+
width: 800px
75+
---
76+
Open the Template File in Editor from the Ipython Shell.
77+
```
7378

7479
Now, a template file with some imports and an empty function is openned for you to write your rule inside the body of
7580
the function as shown bellow:
@@ -115,12 +120,22 @@ So the above is the generated template, and I just filled in the body of the fun
115120
you write `%load` in the Ipython and the function you just wrote will be available to you to test it out in the Ipython
116121
shell as shown bellow (in the GUI just pres the Load button):
117122

118-
<img src="images/load_rule_and_test_it.png" alt="Load Rule in Ipython" width="1200"/>
123+
```{figure} images/load_rule_and_test_it.png
124+
---
125+
width: 1600px
126+
---
127+
Load the written Rule into the Ipython Shell.
128+
```
119129

120130
Then if you want to change the rule, just edit the already open template file and do `load` again. Once you are happy
121131
with your rule results just return the function output as follows (in the GUI just press the Accept button):
122132

123-
<img src="images/accept_rule.png" alt="Accept Rule in Ipython" width="400"/>
133+
```{figure} images/accept_rule.png
134+
---
135+
width: 600px
136+
---
137+
Accept the Rule in Ipython.
138+
```
124139

125140
If you also want to contribute to the semantic world package, then it's better to do that in the `test_views/test_views.py`
126141
test file. Since there is already rules for Drawer, there would already be a test method for that. All you need to do is

examples/fit_reasoner.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ def create_kitchen_world(kitchen_path: str = '../resources/urdf/kitchen-small.ur
1010
kitchen_world = create_kitchen_world()
1111
reasoner = WorldReasoner(kitchen_world)
1212

13-
reasoner.fit_views([Drawer], update_existing_views=True, world_factory=create_kitchen_world)
13+
reasoner.fit_views([Drawer], update_existing_views=True, world_factory=create_kitchen_world)

0 commit comments

Comments
 (0)