You're reading the documentation for a stable version of MoveIt that is not being developed further. For information on the recommended version, please have a look at Main.
How to Cross-Reference Content
This is a primer on how to successfully link to other documents on this website and the API.
There are many and maybe too many different ways to reference content and for new contributors it can be hard to understand what method to use. Some methods may even work locally but then silently fail to create functional links on the deployed website. For that reason, we are requesting contributors to only use the suggested Sphinx roles for cross-referencing content on this website.
Linking to documents and sections using Sphinx’s
:ref:ids generated from the autosectionlabel extension
Referencing the C++ API using the
:cpp_api:role from the doxylink extension
Referencing the API Documentation
The API pages are generated using Doxygen and not Sphinx which means that
:ref: roles are not able to find any API pages.
We are using doxylink and the custom
:cpp_api: role for generating links to the API pages from symbols.
Here are some examples, take note that some links use titles and some not:
functions and members:
:cpp_api:`RobotModel::getName() <moveit::core::RobotModel::getName>`-> RobotModel::getName()
:cpp_api:`moveit::core::RobotModel::enforcePositionBounds(double *state) const`-> moveit::core::RobotModel::enforcePositionBounds(double *state) const
:cpp_api:`RobotModel::root_link_ <moveit::core::RobotModel::root_link_>`-> RobotModel::root_link_
If you are unsure about how to link certain symbols, you can find all Doxygen references inside the
The file is located inside
build/html/<branch>/api/ depending on the build type.
Do’s and Don’ts
Cross-reference as much as possible, especially code
Provide meaningful titles for links or shorten API symbols to improve readability
Use raw URLs for referencing tutorials or the API
Link to GitHub source files, prefer the Doxygen pages