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
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)
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/<IMG/<IMG style=border:0px/g' | ${CMAKE_HOME_DIRECTORY}/tools/doxygen/fig2dev_postprocessor.pl > ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map
COMMAND pwd
COMMAND ${CMAKE_COMMAND} -E tar czf html/msg-tuto-src.tgz msg-tuto-src/
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()
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
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.
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
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