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 a GitHub action to upload API documentation to a webpage #137

Merged
merged 14 commits into from
May 18, 2024

Conversation

boxanm
Copy link
Contributor

@boxanm boxanm commented May 7, 2024

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 boxanm requested a review from pomerlef as a code owner May 7, 2024 15:42
@boxanm
Copy link
Contributor Author

boxanm commented May 7, 2024

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

boxanm commented May 7, 2024

Here's a related PR: norlab-ulaval/libpointmatcher#567

@boxanm
Copy link
Contributor Author

boxanm commented May 18, 2024

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.

@boxanm boxanm merged commit 899ad01 into develop May 18, 2024
1 check passed
@boxanm boxanm deleted the github-action-api-docs branch May 18, 2024 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants