Skip to content

Commit

Permalink
Disable latex and class hierarchy generation (#1447)
Browse files Browse the repository at this point in the history
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
  • Loading branch information
azeey authored and mergify[bot] committed Jun 28, 2024
1 parent 21757c1 commit f2535fe
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
3 changes: 3 additions & 0 deletions doc/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,12 @@ if (DOXYGEN_FOUND)
${CMAKE_BINARY_DIR}/doxygen/html
COMMAND cp ${CMAKE_SOURCE_DIR}/doc/search.js
${CMAKE_BINARY_DIR}/doxygen/html/search
<<<<<<< HEAD
COMMAND make -C ${CMAKE_BINARY_DIR}/doxygen/latex
COMMAND mv ${CMAKE_BINARY_DIR}/doxygen/latex/refman.pdf
${CMAKE_BINARY_DIR}/doxygen/latex/sdf-${SDF_VERSION_FULL}.pdf
=======
>>>>>>> 8e7b267b (Disable latex and class hierarchy generation (#1447))

COMMENT "Generating API documentation with Doxygen" VERBATIM)
endif()
6 changes: 3 additions & 3 deletions doc/sdf.in
Original file line number Diff line number Diff line change
Expand Up @@ -1234,7 +1234,7 @@ SERVER_BASED_SEARCH = NO
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.

GENERATE_LATEX = YES
GENERATE_LATEX = NO

# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
Expand Down Expand Up @@ -1595,7 +1595,7 @@ PERL_PATH = /usr/bin/perl
# this option also works with HAVE_DOT disabled, but it is recommended to
# install and use dot, since it yields more powerful graphs.

CLASS_DIAGRAMS = YES
CLASS_DIAGRAMS = NO

# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see
Expand All @@ -1617,7 +1617,7 @@ HIDE_UNDOC_RELATIONS = YES
# toolkit from AT&T and Lucent Bell Labs. The other options in this section
# have no effect if this option is set to NO (the default)

HAVE_DOT = YES
HAVE_DOT = NO

# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
# allowed to run in parallel. When set to 0 (the default) doxygen will
Expand Down

0 comments on commit f2535fe

Please sign in to comment.