search

ros-infrastructure / rosdoc2

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

Run sphinx-build as a module, ensures pipx compatibility #99

Closed rkent closed 2 months ago

rkent commented 2 months ago

This PR, a followup to PR #95, changes calling sphinx-build from a subprocess to a module. I claim this is useful regardless of any long-term plan of ros2 to recommend use of pipx, as spawning a new subprocess is probably more time consuming than simply running a python module, and we are not really using the subprocess for parallel processing in any way.

But yes this does ensure pipx compatibility, as demonstrated by the included extra testing.

Pragmatically though I'd like to land this now because it is top-of-mind at the moment, and if we revisit in a few months I'd have to figure this out again. I don't see any downside to this.

rkent commented 2 months ago

Oops, sorry about that. I'll fix it.

tfoote commented 2 months ago

I'm not sure what happened here. This fails CI when running on main:

https://github.com/ros-infrastructure/rosdoc2/actions/runs/8726584290