Skip to content
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

fuse -> ROS 2 : Doc Generation #278

Merged
merged 5 commits into from
Jan 28, 2023

Conversation

methylDragon
Copy link
Collaborator

@methylDragon methylDragon commented Oct 7, 2022

See: #276

Another minor port. This uses rosdoc2 to do the document generation.

Most likely the CI/CD has to be updated to use it!
Also, I tried my best to preserve the settings between rosdoc and rosdoc2, but it's not a one-to-one mapping.

Also, you'll notice that I added \ to some of the package descriptions in package.xml, that's because without them doxygen will truncate the description in the generated docs.

I'll leave it to the maintainers to tweak the doc generation configuration!

Try it out by invoking the following on anything other than fuse_docs (since that uses Sphinx instead of Doxygen):

$ mkdir some_doc_dir_to_not_pollute_the_workspace
$ cd some_doc_dir_to_not_pollute_the_workspace
$ rosdoc2 build --package-path <path_to_rosdoc2.yaml_directory>
$ rosdoc2 open ./docs_output/fuse_constraints/api/html/index.html

Pinging @svwilliams for visibility

@methylDragon methylDragon force-pushed the rolling-rosdoc branch 2 times, most recently from 2a4dae6 to c9631c7 Compare October 7, 2022 23:53
@methylDragon methylDragon force-pushed the rolling-rosdoc branch 5 times, most recently from 9d089f9 to cfdb065 Compare November 14, 2022 22:51
@methylDragon methylDragon force-pushed the rolling-rosdoc branch 3 times, most recently from bdb8e53 to 545046c Compare December 8, 2022 21:35
@methylDragon methylDragon force-pushed the rolling-rosdoc branch 2 times, most recently from 65c5dd5 to ed49b8c Compare January 26, 2023 18:42
Signed-off-by: methylDragon <methylDragon@gmail.com>
Signed-off-by: Shane Loretz <sloretz@google.com>
fuse_core/package.xml Show resolved Hide resolved
fuse_doc/package.xml Outdated Show resolved Hide resolved
Signed-off-by: Shane Loretz <sloretz@google.com>
Signed-off-by: Shane Loretz <sloretz@google.com>
Signed-off-by: Shane Loretz <sloretz@google.com>
Copy link
Collaborator

@sloretz sloretz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These look good to me locally.

There are a couple issues we can't resolve at the moment.

However, doc jobs run regularly without needing a new release, so I don't think we should block on those issues. They will get resolved automatically when those two are resolved upstream.

name: 'doxygen',
output_dir: 'api',
extra_doxyfile_statements: [
"FILE_PATTERNS = '*.cpp *.h",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.hpp now too

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, I ended up removing the rosdoc2.yaml files except for fuse_doc. I found the C++ api docs weren't being generated with the custom configs, but seem to work fine with the default settings.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's very strange.. but not a problem I suppose

<li class="toctree-l1"><a href="../fuse_graphs/index.html"/>fuse_graphs</a></li>
<li class="toctree-l1"><a href="../fuse_loss/index.html"/>fuse_loss</a></li>
<li class="toctree-l1"><a href="../fuse_models/index.html"/>fuse_models</a></li>
<li class="toctree-l1"><a href="../fuse_msgs/index.html"/>fuse_msgs</a></li>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one is special, and a broken link for now. rosdoc2 doesn't seem to generate any files for interface packages. I left it in so that it will hopefully start working once rosdoc2 supports that.

@methylDragon methylDragon merged commit a263148 into locusrobotics:rolling Jan 28, 2023
@methylDragon methylDragon deleted the rolling-rosdoc branch January 28, 2023 03:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants