search

rkent / rosdoc2

Command-line tool for generating documentation for ROS 2 packages.
Apache License 2.0
0 stars 0 forks source link

Problems with not using doc/ as sphinx source #23

Open rkent opened 1 month ago

rkent commented 1 month ago

See https://github.com/ros2/message_filters/blob/rolling/doc/references.rst

This package wants to have generated/ in the doc/ folder, but currently I no longer directly support that. This package would need an explicit sphinx_sourcedir option set to work as currently rosdoc2 works. I should try this in older versions to see if I broke it. Can I make it work again without an explicit rosdoc2.yaml entry?

rkent commented 1 month ago

OK I see the issue here. There are .rst files that assume that they are in the sphinx root, but they are actually in doc/.

I tried running this with sphinx_sourcedir='doc' and it works better.

I don't see any easy solution here other than for the original to be modified. They don't really need the "References" anyway.