Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix pyrobosim_ros docs build and move build script to docs folder #269

Merged
merged 5 commits into from
Sep 16, 2024

Conversation

sea-bass
Copy link
Owner

@sea-bass sea-bass commented Sep 16, 2024

I noticed that the pyrobosim_ros.ros_interface module was not being picked up by docs build because of missing ROS interface modules that need to be mocked out, so this PR should address that.

It also moves the generate_docs.bash script from the setup folder to the docs folder, as this makes more sense.

Finally, it updates ReadTheDocs to using Ubuntu 24.04 and Python 3.12, just to get ahead of any more surprises.

@sea-bass sea-bass changed the title Fix docs build and move build script to docs folder Fix pyrobosim_ros docs build and move build script to docs folder Sep 16, 2024
Copy link

Coverage

Coverage Report
FileStmtsMissCoverMissing
__init__.py00100% 
core
   __init__.py90100% 
   dynamics.py47197%140
   gazebo.py136894%55, 124, 230, 244–248
   hallway.py94891%200, 242–245, 269–271
   locations.py1311886%69, 71, 88, 104, 117–118, 120–121, 138, 196, 211, 236, 246, 302–303, 305–306, 335
   objects.py69494%78, 106, 137, 197
   robot.py4646985%263–264, 276, 279, 283–284, 289–290, 336, 359–360, 401–403, 407–411, 436, 439, 443–445, 472, 474, 516–517, 519–520, 537–539, 555–557, 624–626, 651–653, 704–706, 775–777, 829–831, 854, 860, 863, 865, 867, 870–872, 882, 890, 896, 902, 908, 920, 962, 980, 983, 988
   room.py48197%113
   world.py80418976%153–154, 190–191, 195, 269–270, 272–273, 303–304, 366, 380–381, 383–384, 399–401, 421–425, 427–429, 431–432, 435, 437–440, 444–448, 451–453, 456–467, 483–484, 502–504, 518, 520, 523–524, 529–531, 570, 572, 575–576, 581–583, 593–595, 630, 632, 635–636, 641–643, 666, 668, 671–672, 677–679, 725–726, 729, 750, 780–781, 792, 795, 803, 819–823, 825–827, 830–831, 834–837, 839, 842, 844–846, 848–850, 852, 867, 874, 885–889, 924–925, 929–930, 948–949, 955–956, 958–959, 961, 963–964, 966, 968–969, 979–980, 983, 985, 999, 1001, 1008, 1055, 1086–1087, 1110–1111, 1115–1116, 1135–1136, 1140–1141, 1164, 1166–1167, 1203, 1220–1221, 1245, 1310, 1317, 1335–1338, 1350–1353, 1367, 1381, 1425–1426, 1478, 1558–1559, 1625, 1635
   yaml_utils.py108694%61, 65, 167–168, 187–188
gui
   __init__.py20100% 
   main.py2365477%22–24, 45, 77–80, 221–229, 241–249, 256–259, 261, 264–270, 274, 279–280, 284–285, 296, 336–337, 346–347, 351–352, 363–366
   world_canvas.py2965681%46–47, 49–53, 56, 167–170, 174–175, 180–181, 188, 190, 247–249, 255, 272–274, 321, 378–379, 406–407, 409, 411–413, 416–419, 421, 425–431, 434, 437–438, 454, 473, 516, 540, 570, 590, 607
manipulation
   __init__.py10100% 
   grasping.py2366174%102, 110–112, 114–122, 124, 132, 462, 464–466, 470–472, 566–568, 571–575, 583, 586–588, 593–594, 600–604, 607–614, 617–619, 628, 630, 632–638
navigation
   __init__.py11190%37
   a_star.py771185%83–88, 90–92, 180, 189
   execution.py90792%73–75, 80–82, 119
   occupancy_grid.py1391489%44–47, 49–53, 56, 192, 226, 234, 238
   prm.py56492%60–61, 140, 149
   rrt.py1610100% 
   visualization.py32681%88–93
   world_graph.py58493%117, 120, 130, 139
planning
   __init__.py00100% 
   actions.py1120100% 
planning/pddlstream
   __init__.py7185%13
   default_mappings.py90100% 
   planner.py40880%119–126
   primitives.py61493%68, 82, 94, 232
   utils.py99891%66, 93, 105, 115–116, 207–208, 211
utils
   __init__.py00100% 
   general.py33487%23, 45, 51–52
   knowledge.py1542285%86, 117, 156–161, 163–164, 167–168, 170–173, 189, 204, 208, 250, 266, 329
   motion.py70395%93–94, 96
   polygon.py1110100% 
   pose.py890100% 
   search_graph.py93396%240–242
   trajectory.py67297%130, 165
TOTAL425057786% 

Tests Skipped Failures Errors Time
195 0 💤 0 ❌ 0 🔥 3m 29s ⏱️

@sea-bass sea-bass merged commit ff9cdfe into main Sep 16, 2024
7 checks passed
@sea-bass sea-bass deleted the fix-docs-build branch September 16, 2024 01:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant