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

Fix doxygen page links (backport #2553) #2557

Merged
merged 1 commit into from
Aug 30, 2024
Merged

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Aug 30, 2024

🦟 Bug fix

Summary

Seems like there was a behavior change in doxygen that caused the the links in the Maritime section to change from what's expected. This breaks the tool we use to generate issues for the tutorial party. Adding the "title" argument to the \page comand seems to fix it

The link before this PR:

~/ws/ionic/build/gz-sim9/doxygen/html/md__2usr_2local_2google_2home_2addisuzt_2ws_2ionic_2src_2gz-sim_2tutorials_2theory__buoyancy.html#theory_buoyancy

After:
~/ws/ionic/build/gz-sim9/doxygen/html/theory_buoyancy.html

I also took the opportunity to change raw http links to \ref commands

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.


This is an automatic backport of pull request #2553 done by Mergify.

* Fix doxygen page links

Signed-off-by: Addisu Z. Taddese <[email protected]>

* One more page

Signed-off-by: Addisu Z. Taddese <[email protected]>

* Add new lines between refs

Signed-off-by: Addisu Z. Taddese <[email protected]>

---------

Signed-off-by: Addisu Z. Taddese <[email protected]>
(cherry picked from commit c1e367b)
@mergify mergify bot requested a review from mabelzhang as a code owner August 30, 2024 17:02
@mergify mergify bot mentioned this pull request Aug 30, 2024
8 tasks
@github-actions github-actions bot added the 🏛️ ionic Gazebo Ionic label Aug 30, 2024
@azeey
Copy link
Contributor

azeey commented Aug 30, 2024

Ah, I was wondering why the links were still broken. Didn't realize this didn't make it to gz-sim9. Thanks for the backport @iche033

@azeey azeey merged commit a20bf25 into gz-sim9 Aug 30, 2024
7 of 11 checks passed
@azeey azeey deleted the mergify/bp/gz-sim9/pr-2553 branch August 30, 2024 17:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏛️ ionic Gazebo Ionic
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

1 participant