-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Include user documents #90
Conversation
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? |
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for pushing on this. The updates to bring in these additional resources is great.
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.
## Overview [⬆](#swri_dbw_interface)
$$\begin{equation}\label{eq:QP}\tag{QP}
)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.