-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
mock launch components causing rosdoc2 to fail Python API
Signed-off-by: R. Kent James <[email protected]>
- Loading branch information
Showing
2 changed files
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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') |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |