Added Doxyfile #23
Added Doxyfile #23
Conversation
Signed-off-by: ahcorde <ahcorde@gmail.com>
Codecov Report
@@ Coverage Diff @@
## master #23 +/- ##
=======================================
Coverage 25.43% 25.43%
=======================================
Files 26 26
Lines 798 798
Branches 185 185
=======================================
Hits 203 203
Misses 432 432
Partials 163 163
Continue to review full report at Codecov.
|
|
@ahcorde How did you validate this is working? |
|
you can just simply run inside the But I'm integrating many packages in this repo https://github.com/ros2/docs.ros2.org which it's the one on charge of generate the documentation. PR to the repo is on the way |
|
I don't have write permissions here. can you merge it? |
Thanks, I'll try that! Do you have any doc about how to maintain this file? I'd like to understand when/how we should update it? Seems like it's only including the README.md now? |
| TAGFILES += "../../../../doxygen_tag_files/cppreference-doxygen-web.tag.xml=http://en.cppreference.com/w/" | ||
| TAGFILES += "../../../../doxygen_tag_files/rcl.tag=http://docs.ros2.org/latest/api/rcl/" | ||
| TAGFILES += "../../../../doxygen_tag_files/rcpputils.tag=http://docs.ros2.org/latest/api/rcpputils/" |
There was a problem hiding this comment.
When should we change those?
| TAGFILES += "../../../../doxygen_tag_files/rcl.tag=http://docs.ros2.org/latest/api/rcl/" | ||
| TAGFILES += "../../../../doxygen_tag_files/rcpputils.tag=http://docs.ros2.org/latest/api/rcpputils/" | ||
| # Uncomment to generate tag files for cross-project linking. | ||
| GENERATE_TAGFILE = "../../../../doxygen_tag_files/libstatistics_collector.tag" |
|
Merging as this worked, @ahcorde if you could teach us (or write some doc?) about what we're expected to do with this file in the future, that'd be great. |
|
@thomas-moulard this could be interesting, I'll take a look at it later: https://github.com/marketplace/actions/doxygen-action |
|
Nice! Let's see what @ahcorde come up with. That should be fairly similar to how docs.ros2.org is populated. Maybe we could use the action in PRs though to ensure the Doxyfile is still valid? |
My thought exactly. We would at least have local generation to manually review changes, etc. |
|
Sorry for the late response, Doxygen and Sphinx are generated using this script. We manually run it right now. Probably it makes sense to create a package similar to this one https://github.com/ros-infrastructure/rosdoc_lite |
Added Doxyfile to include this package as part of the ROS 2 public API, available at docs.ros2.org.
Signed-off-by: ahcorde ahcorde@gmail.com