Skip to content

Commit

Permalink
mock launch components causing rosdoc2 to fail Python API
Browse files Browse the repository at this point in the history
Signed-off-by: R. Kent James <[email protected]>
  • Loading branch information
rkent committed Nov 12, 2024
1 parent a13359b commit 68cdbb4
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
43 changes: 43 additions & 0 deletions launch_ros/doc/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# -- Path setup --------------------------------------------------------------

import sys

# -- Project information -----------------------------------------------------

copyright = 'The <launch_ros> Contributors. License: Apache License 2.0'

# -- General configuration ---------------------------------------------------

master_doc = 'index'

source_suffix = {
'.rst': 'restructuredtext',
'.md': 'markdown',
'.markdown': 'markdown',
}

# Add mocks for decorators to prevent rosdoc2 hangs

from sphinx.ext.autodoc.mock import mock

with mock(['launch']):
import launch
module = sys.modules['launch']
sys.modules['launch'] = module

with mock(['launch.frontend']):
import launch.frontend
module = sys.modules['launch.frontend']
# These are dummy decorators
module.expose_action = lambda _: lambda _:_
module.expose_substitution = lambda _: lambda _:_
sys.modules['launch.frontend'] = module

with mock(['launch.some_substitutions_type']):
import launch.some_substitutions_type
module = sys.modules['launch.some_substitutions_type']
module.SomeSubstitutionsType_types_tuple = ()
sys.modules['launch.some_substitutions_type'] = module

# We still want autodoc to mock the base 'launch' module
sys.modules.pop('launch')
4 changes: 4 additions & 0 deletions launch_ros/doc/design.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Design Documentation
====================

See [the design document](https://design.ros2.org/articles/roslaunch.html) for more information on the ros2 launch system.

0 comments on commit 68cdbb4

Please sign in to comment.