From 1437b1f25521d507d90e78589106a1bd092b3d82 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Wed, 4 Jun 2014 10:37:42 +0200 Subject: [PATCH] let's build the doc when 'make doc' is called, just in case someone would plan to it --- buildtools/Cmake/GenerateDoc.cmake | 14 +++++++------- doc/doxygen/inside_doxygen.doc | 4 ++-- doc/doxygen/install.doc | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake index c6977a8446..fb465a7568 100644 --- a/buildtools/Cmake/GenerateDoc.cmake +++ b/buildtools/Cmake/GenerateDoc.cmake @@ -7,7 +7,7 @@ mark_as_advanced(JAVADOC_PATH) if(DOXYGEN_PATH) - ADD_CUSTOM_TARGET(simgrid_documentation + ADD_CUSTOM_TARGET(doc COMMENT "Generating the SimGrid documentation..." DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen} COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html @@ -24,7 +24,7 @@ if(DOXYGEN_PATH) COMMAND false ) - add_dependencies(simgrid_documentation error_doxygen) + add_dependencies(doc error_doxygen) endif() configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY) @@ -32,19 +32,19 @@ if(DOXYGEN_PATH) foreach(file ${DOC_FIGS}) string(REPLACE ".fig" ".png" tmp_file ${file}) string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file}) - ADD_CUSTOM_COMMAND(TARGET simgrid_documentation + ADD_CUSTOM_COMMAND(TARGET doc COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file} ) endforeach() foreach(file ${DOC_IMG}) ADD_CUSTOM_COMMAND( - TARGET simgrid_documentation + TARGET doc COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/ ) endforeach() - ADD_CUSTOM_COMMAND(TARGET simgrid_documentation + ADD_CUSTOM_COMMAND(TARGET doc COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/shared/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/ ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map COMMAND pwd COMMAND ${CMAKE_COMMAND} -E tar czf html/msg-tuto-src.tgz msg-tuto-src/ @@ -73,7 +73,7 @@ if(DOXYGEN_PATH) COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/ ) - add_dependencies(pdf simgrid_documentation) + add_dependencies(pdf doc) endif() @@ -94,7 +94,7 @@ add_custom_target(sync-gforge-doc WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}" ) -add_dependencies(sync-gforge-doc simgrid_documentation) +add_dependencies(sync-gforge-doc doc) add_custom_target(sync-gforge-dtd COMMAND ${RSYNC_CMD} src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/simgrid.dtd diff --git a/doc/doxygen/inside_doxygen.doc b/doc/doxygen/inside_doxygen.doc index a120f17e58..f5990353d6 100644 --- a/doc/doxygen/inside_doxygen.doc +++ b/doc/doxygen/inside_doxygen.doc @@ -181,7 +181,7 @@ complete your day. If you need to run a command (like fig2dev) to generate your image, edit buildtools/Cmake/GenerateDoc.cmake and add your command to the -simgrid_documentation target (grep for fig2dev in the file to see +doc target (grep for fig2dev in the file to see where exactly). Don't forget to add the source of your image to the archive somehow. You can add it to the list DOC_FIG of buildtools/Cmake/DefinePackage.cmake. @@ -210,7 +210,7 @@ Once you've changed the doc, you want to run doxygen to regenerate the html output (and maybe the pdf too). Here is how to do this: @verbatim -make simgrid_documentation # html documentation +make doc # html documentation make pdf # the result is in doc/latex/simgrid_documentation.pdf @endverbatim diff --git a/doc/doxygen/install.doc b/doc/doxygen/install.doc index e96be08853..bea5ec5a58 100644 --- a/doc/doxygen/install.doc +++ b/doc/doxygen/install.doc @@ -320,7 +320,7 @@ make install Install the project (doc/ bin/ lib/ include/) make uninstall Uninstall the project (doc/ bin/ lib/ include/) make dist Cuild a distribution archive (tgz) make distcheck Check the dist (make + make dist + tests on the distribution) -make simgrid_documentation Create simgrid documentation +make doc Create simgrid documentation @endverbatim If you want to see what is really happening, try adding VERBOSE=1 to -- 2.20.1