ros-infrastructure / catkin_pkg

Standalone Python library for the catkin build system.
https://github.com/ros/catkin
Other
47 stars 89 forks source link

Generate documentation using sphinx-rtd-theme. #306

Open nuclearsandwich opened 3 years ago

nuclearsandwich commented 3 years ago

These two commands, together with forthcoming changes for the doc-independent job configuration will switch the catkin_pkg API documentation to the rtd theme.

So we're not as consistent currently as I thought in the offline discussion earlier today. rospkg and rosdep currently use the ros-theme while rosinstall and vcstools currently use the haiku theme. catkin-pkg and rosdistro use the default sphinx theme since both generate their sphinx conf.py files with sphinx-apidoc.

Trying to apply retroactive logic to the above, it seems like ros utility packages use the ROS theme and vcstools packages (including rosinstall) use the haiku theme, while catkin_pkg and rosdistro, which have a conf.py generated by sphinx-apidoc, use the default theme.

The scripts here could easily be modified to target the ROS theme rather than RTD although if I compare the two I personally find rtd to be more readable. Once this is settled I'll open a sibling PR on rosdistro so that the two of them are using the same theme.