search

norlab-ulaval / libnabo

A fast K Nearest Neighbor library for low-dimensional spaces
http://norlab-ulaval.github.io/libnabo/
BSD 3-Clause "New" or "Revised" License
431 stars 142 forks source link

Add a GitHub action to upload API documentation to a webpage #137

Closed boxanm closed 1 month ago

boxanm commented 2 months ago

Description

Summary:

Changes and type of changes (quick overview):

Add a GitHub action to upload API documentation to a webpage. The webpage is already live on https://norlab-ulaval.github.io/libnabo/ and will be updated automatically on merge to master.

boxanm commented 2 months ago

Integration tests fail due to this line in libpointmatcher:

#if NABO_VERSION_INT < 10007
    #error "You need libnabo version 1.0.7 or greater"
#endif

I think keeping version numbers in header file is a bad practice and that's why this PR contains removal of NABO_VERSION_INT and NABO_VERSION from nabo.h . Dependency version check can and should happen in relevant requirement and CMakeList files. @RedLeader962 I suggest we merge this PR and remove the mentioned lines from libpointmatcher in the next release.

boxanm commented 2 months ago

Here's a related PR: https://github.com/norlab-ulaval/libpointmatcher/pull/567

boxanm commented 1 month ago

Finally, I kept the NABO_VERSION_INT and NABO_VERSION in nabo.h so that the integration test doesn't fail and we avoid the chicken or the egg dilemma of whether first to merge libnabo or libpointmatcher. We can remove these constants in the following release.