ros-infrastructure / rosdoc2

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

Include user documents #90

Closed rkent closed 2 months ago

rkent commented 2 months ago

fixes #83

This PR is fairly significant, because it adds user documentation from the /doc folder into rosdoc2.

Notes:

To help with review, I processed packages that have /doc folders, and uploaded the results to http://test1.rosdabbler.com You can also get some idea looking at the rendering of full_package in the test suite.

Much of the time the result is favorable. However there are a number of issues that can be seen.

Some of these issues might be fixed with adding additional options to myst, or with other fixes. I am going to recommend though that we deal with those in followup PRs, rather than try here to fix issues in specific package renderings.

tfoote commented 2 months ago

The others are merged and this now has a conflict, probably the fixups from before the merge.

The example output looks great such as rclcpp's API review just popping out http://test1.rosdabbler.com/rclcpp/

One I noticed as the fuse_doc directory here: http://test1.rosdabbler.com/fuse_doc/ that appears to have overridden the wrapper. Is that from a different test or did it's sphinx take over the wrapped invocation?

rkent commented 2 months ago

fuse_doc has completely replaced our generated index.rst and conf.py with their own. See http://docs.ros.org/en/iron/p/fuse_doc/ it should be no different.

This should be ready for review again.