-
Notifications
You must be signed in to change notification settings - Fork 112
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
fuse -> ROS 2 : Doc Generation #278
Conversation
2a4dae6
to
c9631c7
Compare
9d089f9
to
cfdb065
Compare
bdb8e53
to
545046c
Compare
65c5dd5
to
ed49b8c
Compare
Signed-off-by: methylDragon <methylDragon@gmail.com>
ed49b8c
to
7722a69
Compare
Signed-off-by: Shane Loretz <sloretz@google.com>
Signed-off-by: Shane Loretz <sloretz@google.com>
Signed-off-by: Shane Loretz <sloretz@google.com>
Signed-off-by: Shane Loretz <sloretz@google.com>
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.
These look good to me locally.
There are a couple issues we can't resolve at the moment.
- The first is fuse_doc requires an upstream fix in
rosdoc2
to render correctly: Copy user files into docs_build so they can be referenced in conf.py ros-infrastructure/rosdoc2#47 - The second is
rosdoc2
doesn't currently generate anything for interface packages.
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.
fuse_core/rosdoc2.yaml
Outdated
name: 'doxygen', | ||
output_dir: 'api', | ||
extra_doxyfile_statements: [ | ||
"FILE_PATTERNS = '*.cpp *.h", |
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.
.hpp
now too
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.
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.
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.
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> |
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.
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.
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 inpackage.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):
Pinging @svwilliams for visibility