-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add package dependency graph using graphviz extension
Add a simple package dependency graph, using graphviz. Use the graphviz Sphinx extension to directly link to the dot file, instead of manually creating an image file.
- Loading branch information
Showing
3 changed files
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,6 +29,7 @@ | |
# ones. | ||
extensions = [ | ||
"sphinx.ext.intersphinx", | ||
"sphinx.ext.graphviz", | ||
"sphinx.ext.todo", | ||
] | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# to view while editing, use `dot -Tpng package_relationship.dot | display` | ||
digraph PACKAGES { | ||
edge [style=dashed fontsize=10]; | ||
|
||
# invisible edge to make the robot_interfaces node appear on top | ||
robot_interfaces -> robot_fingers [style=invis]; | ||
|
||
entry [label="entry point\nfor users" shape=none]; | ||
|
||
entry -> robot_fingers [style=solid]; | ||
entry -> trifinger_simulation [style=solid]; | ||
robot_fingers -> robot_interfaces [label="interface\ndefinition"]; | ||
robot_fingers -> blmc_drivers [label="hardware\ncommunication"]; | ||
robot_fingers -> trifinger_cameras [label="camera\naccess"]; | ||
robot_fingers -> trifinger_object_tracking [label="camera + \nobject tracking"]; | ||
robot_fingers -> robot_properties_fingers [label="forward/inverse\nkinematics"]; | ||
trifinger_cameras -> robot_interfaces [label="interface\ndefinition"]; | ||
|
||
# only for some example scripts, so not really worth adding here | ||
#trifinger_object_tracking -> robot_properties_fingers [label="forward/inverse\nkinematics"]; | ||
|
||
trifinger_object_tracking -> trifinger_cameras [label="camera\naccess"]; | ||
trifinger_simulation -> robot_properties_fingers [label="robot model"]; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters