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

Disable latex and class hierarchy generation (backport #1447) #1450

Merged
merged 1 commit into from
Jul 2, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Jun 28, 2024

Summary

We don't use the latex output anywhere, but it brings in a big dependency when building documentation or deb packages. The class hierarchy is also not that useful since there is not much inheritance used in the codebase. This also brings the doxygen parameters of sdformat closer to other Gazebo libraries.

Note: I plan to Backport this to all the previous versions of sdformat

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 #1447 done by Mergify.

Copy link
Contributor Author

mergify bot commented Jun 28, 2024

Cherry-pick of 8e7b267 has failed:

On branch mergify/bp/sdf13/pr-1447
Your branch is up to date with 'origin/sdf13'.

You are currently cherry-picking commit 8e7b267b.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   doc/sdf.in

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   doc/CMakeLists.txt

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot added the conflicts label Jun 28, 2024
@mergify mergify bot requested review from azeey and scpeters as code owners June 28, 2024 21:04
@github-actions github-actions bot added the 🌱 garden Ignition Garden label Jun 28, 2024
We don't use the latex output anywhere, but it brings in a big
dependency when building documentation or deb packages.
The class hierarchy is also not that useful since there is not much
inheritance used in the codebase. This also brings the doxygen
parameters of sdformat closer to other Gazebo libraries.

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
(cherry picked from commit 8e7b267)
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
@scpeters scpeters merged commit 6814763 into sdf13 Jul 2, 2024
11 checks passed
@scpeters scpeters deleted the mergify/bp/sdf13/pr-1447 branch July 2, 2024 20:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌱 garden Ignition Garden
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants