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

Expose QPFunction in the documentation #374

Merged
merged 5 commits into from
Feb 11, 2025

Conversation

stephane-caron
Copy link
Contributor

@stephane-caron stephane-caron commented Feb 11, 2025

Closes #369

This PR adds a page and formats the docstring of QPFunction in a Doxygen-compatible way:

QPFunction page

image

QPLayer page

It also links to it from the QPLayer page:

image

@hrp2-14
Copy link
Member

hrp2-14 commented Feb 11, 2025

Hi ! This project doesn't usually accept pull requests on the main branch.
If this wasn't intentionnal, you can change the base branch of this PR to devel
(No need to close it for that). Best, a bot.

@stephane-caron stephane-caron changed the base branch from main to devel February 11, 2025 16:19
@ManifoldFR ManifoldFR self-requested a review February 11, 2025 16:56
@ManifoldFR
Copy link
Member

ManifoldFR commented Feb 11, 2025

Thanks @stephane-caron !

The screenshot of the doc reminds me that we should think of moving to the doxygen-awesome theme or mosra's m.css Doxygen theme, because it looks like a website made when Chirac was president

@ManifoldFR ManifoldFR enabled auto-merge February 11, 2025 22:20
@ManifoldFR ManifoldFR merged commit c1218c8 into Simple-Robotics:devel Feb 11, 2025
93 checks passed
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.

QPFunction is documented but not in the documentation
3 participants