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

Add doc on C++ API #511

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add doc on C++ API #511

wants to merge 3 commits into from

Conversation

Abishalini
Copy link
Contributor

@Abishalini Abishalini commented Dec 4, 2023

This is an attempt to add more information on stages provided by MTC and how to use them using C++.

How to build the docs

cd ~/path/to/moveit_task_constructor
sphinx-build core/doc _site

The HTML files can be accessed in the _site folder.

Make sure you have the latest version of Sphinx by pip install -U sphinx.
Since I primarily work with ros2, I don't have some dependencies required to build the docs. You might encounter this error

Extension error (sphinx.ext.autosummary):
Handler <function process_generate_options at 0x7fc729afc8b0> for event 'builder-inited' threw an exception (exception: no module named moveit)

If you encounter the error, comment out the Python section from api.rst

TODO:

  • Potentially reorder sections. There is some duplicate information between the Python examples and the C++ examples I have added
  • Figure out versioning between master and ros2 branches.
  • Add more information/pictures about debugging using the RViz.

Copy link

codecov bot commented Dec 4, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c605a00) 59.02% compared to head (3247989) 58.80%.
Report is 6 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #511      +/-   ##
==========================================
- Coverage   59.02%   58.80%   -0.22%     
==========================================
  Files          90       90              
  Lines        8482     8705     +223     
==========================================
+ Hits         5006     5118     +112     
- Misses       3476     3587     +111     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Abishalini Abishalini marked this pull request as ready for review December 27, 2023 15:49
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