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

Add Doxyfile back to code repo #68

Merged
merged 4 commits into from
Feb 16, 2024

Conversation

Briancbn
Copy link
Member

@Briancbn Briancbn commented Feb 8, 2024

  • Leave the Doxyfile in the code repo instead of the doc repo.

This along with ros-industrial/epd_docs#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

@Briancbn Briancbn added the documentation Improvements or additions to documentation label Feb 8, 2024
@Briancbn Briancbn requested a review from carlowiesse February 8, 2024 04:50
Signed-off-by: Chen Bainian <[email protected]>
Signed-off-by: Chen Bainian <[email protected]>
Copy link

codecov bot commented Feb 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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
@@           Coverage Diff           @@
##           master      #68   +/-   ##
=======================================
  Coverage   76.45%   76.45%           
=======================================
  Files          10       10           
  Lines        1355     1355           
=======================================
  Hits         1036     1036           
  Misses        319      319           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@carlowiesse
Copy link
Contributor

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
Copy link
Member Author

Briancbn commented Feb 9, 2024

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
Copy link
Contributor

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

@carlowiesse carlowiesse merged commit b782ba2 into ros-industrial:master Feb 16, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants