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 #1447

Merged
merged 1 commit into from
Jun 28, 2024

Conversation

azeey
Copy link
Collaborator

@azeey azeey 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.

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>
@azeey azeey requested a review from scpeters as a code owner June 28, 2024 16:53
@github-actions github-actions bot added the 🏛️ ionic Gazebo Ionic label Jun 28, 2024
@scpeters
Copy link
Member

make doc is also much faster with this change

@azeey azeey merged commit 8e7b267 into gazebosim:main Jun 28, 2024
11 checks passed
@azeey azeey deleted the disable_latex branch June 28, 2024 21:02
@azeey
Copy link
Collaborator Author

azeey commented Jun 28, 2024

@Mergifyio Backport sdf9 sdf12 sdf13 sdf14

Copy link
Contributor

mergify bot commented Jun 28, 2024

Backport sdf9 sdf12 sdf13 sdf14

❌ Sorry but I didn't understand the command. Please consult the commands documentation 📚.

@azeey
Copy link
Collaborator Author

azeey commented Jun 28, 2024

https://github.com/Mergifyio backport sdf9 sdf12 sdf13 sdf14

Copy link
Contributor

mergify bot commented Jun 28, 2024

backport sdf9 sdf12 sdf13 sdf14

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request 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)

# Conflicts:
#	doc/CMakeLists.txt
mergify bot pushed a commit that referenced this pull request 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)

# Conflicts:
#	doc/CMakeLists.txt
mergify bot pushed a commit that referenced this pull request 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)

# Conflicts:
#	doc/CMakeLists.txt
mergify bot pushed a commit that referenced this pull request 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)
azeey added a commit that referenced this pull request Jul 1, 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)
scpeters pushed a commit that referenced this pull request Jul 1, 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)
scpeters pushed a commit that referenced this pull request Jul 2, 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)
azeey added a commit that referenced this pull request Jul 2, 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 pushed a commit that referenced this pull request Jul 2, 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.

(cherry picked from commit 8e7b267)

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Co-authored-by: Addisu Z. Taddese <addisu@openrobotics.org>
azeey added a commit that referenced this pull request Jul 3, 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)
scpeters pushed a commit that referenced this pull request Jul 3, 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)
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.

2 participants