From 9a90ccf8f47f0de43b9619c6da01d0a7666cb8f0 Mon Sep 17 00:00:00 2001 From: "Addisu Z. Taddese" Date: Fri, 28 Jun 2024 16:02:45 -0500 Subject: [PATCH] Disable latex and class hierarchy generation (#1447) 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 (cherry picked from commit 8e7b267b4b52ec892e53cd9d1a1032c3eee5f82a) --- doc/CMakeLists.txt | 3 --- doc/sdf.in | 6 +++--- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index 66d4caa6a..46a775b84 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -13,9 +13,6 @@ if (DOXYGEN_FOUND) ${CMAKE_BINARY_DIR}/doxygen/html COMMAND cp ${CMAKE_SOURCE_DIR}/doc/search.js ${CMAKE_BINARY_DIR}/doxygen/html/search - COMMAND make -C ${CMAKE_BINARY_DIR}/doxygen/latex - COMMAND mv ${CMAKE_BINARY_DIR}/doxygen/latex/refman.pdf - ${CMAKE_BINARY_DIR}/doxygen/latex/sdf-${PROJECT_VERSION_FULL}.pdf COMMENT "Generating API documentation with Doxygen" VERBATIM) endif() diff --git a/doc/sdf.in b/doc/sdf.in index 9865bc35b..30298aef3 100644 --- a/doc/sdf.in +++ b/doc/sdf.in @@ -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 @@ -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 @@ -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