ros-industrial / easy_perception_deployment

A ROS2 package that accelerates the training and deployment of CV models for industries.
Apache License 2.0
53 stars 16 forks source link

Add Doxyfile back to code repo #68

Closed Briancbn closed 7 months ago

Briancbn commented 7 months ago

This along with https://github.com/ros-industrial/epd_docs/pull/3 should fix the breathe usage in the ReadtheDocs

How to use this with emd_docs repo.

git clone https://github.com/ros-industrial/easy_perception_deployment.git
git clone https://github.com/ros-industrial/epd_docs.git

Generate the doxygen xml in epd source code

cd easy_perception_deployment/
doxygen

Create a symlink of the build in epd_docs

cd epd_docs/docs  # updated
ln -s ../../easy_perception_deployment/_build doxygen-build  # updated

Build the documentation

make html
codecov[bot] commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (88db293) 76.45% compared to head (7c4c175) 76.45%. Report is 1 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #68 +/- ## ======================================= Coverage 76.45% 76.45% ======================================= Files 10 10 Lines 1355 1355 ======================================= Hits 1036 1036 Misses 319 319 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

carlowiesse commented 7 months ago

Tested it, looks good, two notes: 1) The last block of instructions on how to make the html should be

```
cd epd_docs/docs
make html
```

2) The HTML shows missing information for the whole API section. If you try clicking on each individual field, the last thing you get is doxygenfile: Cannot find file “epd_container.hpp or doxygenfile: Cannot find file “Counting.py, to mention a few. Is there a way to fix that? Or should we leave it like that? or would you prefer to remove the whole API section from the html? @Briancbn

Briancbn commented 7 months ago

Thanks for testing it out @carlowiesse

Could you try pr-fix-readthedocs branch instead for epd_docs? The old one didn't update the symbolic link path for the generate Doxygen XML.

The ReadTheDocs generated HTML is able to find the Doxygen generated XML with no issues.

I also updated the symbolic link instruction, hopefully that was not causing trouble.


Update

Sorry my bad. I accidentally removed the GENERATE_XML = YES in the Doxyfile. Adding them back in.

carlowiesse commented 7 months ago

Tested it, previous issues have been resolved, just one more issue: P1Trainer, processor and p1_ort_base still not found in the HTML (HPP files for those 3 were not found by Doxygen).

Reason: These 3 files don't exist in the EPD repo anymore. I see them in archived tags for milestone 1 and 2 of the EPD project, but they are not present in any other tags or branches. So we need to remove some RST files from the epd_docs repo.

Note: There's another PR in epd_docs, I'll suggest the fix there and, once that's settled, I'll proceed with the merge here @Briancbn