change docs file structure to work with recent rosdoc2 #930
Conversation
Signed-off-by: Jonas Otto <jonas@jonasotto.com>
fujitatomoya
left a comment
fujitatomoya
left a comment
There was a problem hiding this comment.
@ottojo my understanding is that this PR replaces ros2/ros2_documentation#6043, right? IMO this fix makes much better than ros2/ros2_documentation#6043.
yes, this is intended to replace 6043 |
| Links <__links> | ||
| Python API <modules> | ||
| Standard Documents <__standards> | ||
| ROS Package Dependencies <__ros_package_dependencies> |
There was a problem hiding this comment.
I can see this error
WARNING: toctree contains reference to nonexisting document '__ros_package_dependencies' [toc.not_readable]There was a problem hiding this comment.
I can't reproduce this, is this on the buildfarm or locally for you? This probably happens with a (perhaps just slightly) out of date rosdoc2, as this only got merged recently: ros-infrastructure/rosdoc2#205
There was a problem hiding this comment.
I'm running version rosdoc2 0.2.2.dev0, I used a virtual env to install rosdoc2 with the latest changes but I can't see this directory.
I'm using this cmd:
rosdoc2 build --package-path ./src/ros2/launch/launch| ROS Package Dependencies <__ros_package_dependencies> | ||
|
|
||
|
|
||
| Indices and tables | ||
| ================== |
There was a problem hiding this comment.
| ROS Package Dependencies <__ros_package_dependencies> | |
| Indices and tables | |
| ================== |
|
@ottojo can you address the comments? |
3 participants
Description
This moves the sphinx docs sources one directory up, as expected by rosdoc2. Furthermore, the sphinx sourcedir is configured in rosdoc2.yaml, which is how to tell rosdoc2 to use the existing index.rst instead of wrapping it (https://github.com/ros-infrastructure/rosdoc2/blob/main/doc/index.rst.md).
I have added toctree entries for the autogenerated documentation elements by rosdoc2.
This should also fix ros2/ros2_documentation#6042
Is this user-facing behavior change?
Yes, the documentation page will change. It seems however (as apparent in the issue above), that the resulting link to architecture.html was changed inadvertently at some point. This reverts it back to the original link.
Did you use Generative AI?
No.
Additional info
Needs
@Mergifyio backport humble jazzy rolling