X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/0d7892edd1574f6a08a0a9b8f7f00c35e9519418..3d89e90c0308155d5309f8f7e7cfa4e716242570:/buildtools/Cmake/GenerateDoc.cmake diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake index 90cbac4002..a2739f533d 100644 --- a/buildtools/Cmake/GenerateDoc.cmake +++ b/buildtools/Cmake/GenerateDoc.cmake @@ -1,17 +1,3 @@ -#### Generate the manpages -if( NOT MANPAGE_DIRECTORY ) - set( MANPAGE_DIRECTORY /usr/share/man/man1 ) -endif( NOT MANPAGE_DIRECTORY) - -set(MANPAGES doc/simgrid_update_xml.1) - -add_custom_command(OUTPUT doc/simgrid_update_xml.1 - COMMAND pod2man tools/simgrid_update_xml.pl > doc/simgrid_update_xml.1 - COMMENT "Generating manpage for simgrid_update_xml" -) -install(FILES ${MANPAGES} - DESTINATION $ENV{DESTDIR}${CMAKE_INSTALL_PREFIX}/share/man/man1/) - #### Generate the html documentation if(BIBTEX2HTML) @@ -22,8 +8,6 @@ endif(BIBTEX2HTML) find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS) find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS) -find_path(BIBTOOL_PATH NAMES bibtool PATHS NO_DEFAULT_PATHS) -find_path(ICONV_PATH NAMES iconv PATHS NO_DEFAULT_PATHS) ### Check whether the bibtex2html that we found is the one that Arnaud requires exec_program("${BIBTEX2HTML_PATH}/bibtex2html -version" OUTPUT_VARIABLE OUTPUT_BIBTEX2HTML_VERSION) @@ -41,9 +25,7 @@ else(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # g SET(GOOD_BIBTEX2HTML_VERSION 1) endif(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) -if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION) - - string(REGEX REPLACE ";.*logcategories.doc" "" LISTE_DEUX "${LISTE_DEUX}") +if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION) #DOC_SOURCE=doc/*.doc, defined in DefinePackage set(DOCSSOURCES "${source_doxygen}\n${DOC_SOURCE}") @@ -52,8 +34,15 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV set(DOC_PNGS ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_small.png ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_05.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_06.png ) configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY) @@ -61,11 +50,13 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV ADD_CUSTOM_TARGET(simgrid_documentation COMMENT "Generating the SimGrid documentation..." - DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen} ${DOC_bib} ${MANPAGES} + DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen} + COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html + COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/html COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/ ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc ) - + ADD_CUSTOM_COMMAND( OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc DEPENDS ${source_doxygen} @@ -93,6 +84,7 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/ COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png ${CMAKE_HOME_DIRECTORY}/doc/html/ COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png ${CMAKE_HOME_DIRECTORY}/doc/html/ + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/AS_hierarchy.png ${CMAKE_HOME_DIRECTORY}/doc/html/ COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/ ) @@ -100,7 +92,7 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass" COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl FAQ.doc index.doc contrib.doc gtut-introduction.doc history.doc + COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl pls.doc index.doc FAQ.doc gtut-introduction.doc install.doc bindings.doc options.doc tracing.doc platform.doc COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass" COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile @@ -108,7 +100,6 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV COMMAND ${CMAKE_COMMAND} -E echo "XX Post-processing Doxygen result" COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir* COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_php.pl index.php.in html/index.html index.php COMMAND ${CMAKE_COMMAND} -E echo "XX Create shortcuts pages" COMMAND ${CMAKE_COMMAND} -E echo \"\" > ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html @@ -124,30 +115,8 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV COMMAND ${CMAKE_COMMAND} -E echo \"


DAG Simulator.

\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/simdag.html WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/ ) - - ADD_CUSTOM_TARGET(bib_files - DEPENDS ${CMAKE_HOME_DIRECTORY}/doc/all.bib - COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html - COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/html - COMMAND ${CMAKE_COMMAND} -E echo "XX Generate publis_core.bib publis_extern.bib publis_intra.bib" - COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category \"core\"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' all.bib -o publis_core.bib - COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category \"extern\"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' all.bib -o publis_extern.bib - COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category \"intra\"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' all.bib -o publis_intra.bib - - COMMAND ${CMAKE_COMMAND} -E echo "XX Generate publis_count.html" - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_table_count.pl < ${CMAKE_HOME_DIRECTORY}/doc/all.bib > ${CMAKE_HOME_DIRECTORY}/doc/publis_count.html - - COMMAND ${CMAKE_COMMAND} -E echo "XX Generate publis_core.html publis_extern.html publis_intra.html" - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl publis_core - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl publis_extern - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl publis_intra - - WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/ - ) - - add_dependencies(simgrid_documentation bib_files) -else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION) +else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION) ADD_CUSTOM_TARGET(simgrid_documentation COMMENT "Generating the SimGrid documentation..." @@ -166,16 +135,14 @@ else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICO ADD_CUSTOM_COMMAND(TARGET simgrid_documentation COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}" COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}" - COMMAND ${CMAKE_COMMAND} -E echo "BIBTOOL_PATH = ${BIBTOOL_PATH}" COMMAND ${CMAKE_COMMAND} -E echo "BIBTEX2HTML_PATH = ${BIBTEX2HTML_PATH}" - COMMAND ${CMAKE_COMMAND} -E echo "ICONV_PATH = ${ICONV_PATH}" COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!" COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..." COMMAND false ) -endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION) +endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTEX2HTML_PATH AND GOOD_BIBTEX2HTML_VERSION) ##############################################################################" @@ -293,3 +260,17 @@ else(compare_files) endif(compare_files) file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc) + +ADD_CUSTOM_TARGET(pdf + COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf" + COMMAND make clean + COMMAND make pdf || true + COMMAND ${CMAKE_COMMAND} -E echo "XX Second pass simgrid_documentation.pdf" + COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf + COMMAND make pdf || true + COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf" + 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)