Closed Briancbn closed 7 months ago
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.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
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
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.
Sorry my bad.
I accidentally removed the GENERATE_XML = YES
in the Doxyfile
. Adding them back in.
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
This along with https://github.com/ros-industrial/epd_docs/pull/3 should fix the
breathe
usage in the ReadtheDocsHow to use this with emd_docs repo.
Generate the doxygen xml in epd source code
Create a symlink of the build in
epd_docs
Build the documentation