Skip to content

Commit

Permalink
intersphinx links to rclpy and rclcpp
Browse files Browse the repository at this point in the history
  • Loading branch information
ottojo committed Aug 22, 2023
1 parent b4a3231 commit a7f36e0
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
13 changes: 11 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = ['sphinx.ext.autodoc', 'sphinx-jsonschema']
extensions = [
'sphinx.ext.autodoc',
'sphinx-jsonschema',
'sphinx.ext.intersphinx',
]
autoclass_content = 'both'
sys.path.insert(0, '../ros2/orchestrator')

Expand All @@ -25,11 +29,16 @@
'lift_description': True,
}

intersphinx_mapping = {
"rclcpp": ("http://docs.ros.org/en/rolling/p/rclcpp", None),
"rclpy": ("http://docs.ros.org/en/rolling/p/rclpy/", None)
}
intersphinx_disabled_reftypes = ["*"]

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
numfig = True


# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

Expand Down
2 changes: 1 addition & 1 deletion docs/user_docs/adapting_nodes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Omitted Outputs
Status messages may list ``omitted_outputs``.
This is a list of topic outputs which would usually occur during the current callback, but will not occur in this specific callback invocation.
It must contain remapped topic names, not internal names.
The actual topic name is available from ROS publishers:
The actual topic name is available from ROS publishers in ``rclcpp`` (:external+rclcpp:cpp:func:`rclcpp::PublisherBase::get_topic_name <rclcpp::PublisherBase::get_topic_name>`) and ``rclpy`` (:external+rclpy:py:attr:`rclpy.publisher.Publisher.topic_name`):

.. code-block:: cpp
Expand Down

0 comments on commit a7f36e0

Please sign in to comment.