Using Sphinx for cross-referencing packages¶
This is an example of how you can cross-reference packages documentation within rosindex using Sphinx.
Inventory files must be added to ROSIndex Sphinx’s
conf.py file found here. Note that the
URI added to the configuration file must point to the directory where the
.inv file is rather than to the file itself (i.e:
http://docs.ros.org/independent/api/catkin_pkg instead of
Examples of intersphinx in action¶
Links to source code can be created as follows:
Class :class:`vcstools.VcsClient` implements the :meth:`vcstools.VcsClient.checkout` method.
Links to documentation pages:
Refer to :doc:`vcstools Developer's Guide document<developers_guide>`.
Refer to vcstools Developer’s Guide document.
Links to other pages in this documentation:
See `the installation page <Installation>`.