Skip to content

Commit

Permalink
add Known Issues section.
Browse files Browse the repository at this point in the history 
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
  • Loading branch information
@fujitatomoya
fujitatomoya committed Mar 17, 2024
1 parent 0c09099 commit 50ab26c
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ rosdoc2 build \
```

> [!NOTE]
> Please make sure that ROS 2 colcon workspace is NOT sourced during build.
> Please see [Known Issues](#known-issues) if failed.
This command will inspect your package and run various documentation tools based on the configuration of your package.

Expand Down Expand Up @@ -197,3 +197,9 @@ TODO
## Contributing

TODO

## Known Issues

| Description / Error Message | Issue | Workaround |
|:---|:---:|:---|
| `No module named 'rclpy._rclpy_pybind11'` | #66 | Do not source colcon workspace. |

0 comments on commit 50ab26c

Please sign in to comment.