X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/651a8ba37d86440d8194da06e1e920c6de399e51..84ab13215ff2acde423a88ef6accfe301cee098f:/buildtools/Cmake/GenerateDoc.cmake
diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake
index 83e683bdcc..21f403f6f9 100644
--- a/buildtools/Cmake/GenerateDoc.cmake
+++ b/buildtools/Cmake/GenerateDoc.cmake
@@ -1,3 +1,5 @@
+#### Generate the html documentation
+
if(BIBTEX2HTML)
set(BIBTEX2HTML_PATH ${BIBTEX2HTML})
else(BIBTEX2HTML)
@@ -6,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)
@@ -25,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}")
@@ -35,9 +33,46 @@ 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
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_001.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_002.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_003.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_004.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_005.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_006.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_007.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_008.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_009.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_010.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_011.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_012.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_013.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_014.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_015.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_016.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_017.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_018.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_019.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_020.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_021.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_022.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_023.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_024.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_025.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_026.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_027.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_028.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_029.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101_030.png
+ ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid-101.pdf
)
configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
@@ -46,10 +81,12 @@ 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}
+ 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}
@@ -62,7 +99,7 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV
string(REPLACE ".fig" ".png" tmp_file ${file})
string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
- COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng ${file} ${tmp_file}
+ COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file}
)
endforeach(file ${DOC_FIGS})
@@ -77,6 +114,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/
)
@@ -84,7 +122,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
@@ -92,7 +130,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
@@ -108,30 +145,8 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV
COMMAND ${CMAKE_COMMAND} -E echo \"\" >> ${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..."
@@ -150,23 +165,39 @@ 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)
##############################################################################"
message(STATUS "Check individual TOCs")
-file(GLOB_RECURSE LISTE_GTUT
- "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour-*.doc"
+set(LISTE_GTUT
+ doc/gtut-tour-00-install.doc
+ doc/gtut-tour-01-bones.doc
+ doc/gtut-tour-02-simple.doc
+ doc/gtut-tour-03-args.doc
+ doc/gtut-tour-04-callback.doc
+ doc/gtut-tour-05-globals.doc
+ doc/gtut-tour-06-logs.doc
+ doc/gtut-tour-07-timers.doc
+ doc/gtut-tour-08-exceptions.doc
+ doc/gtut-tour-09-simpledata.doc
+ doc/gtut-tour-10-rpc.doc
+ doc/gtut-tour-11-explicitwait.doc
+ doc/gtut-tour-recap-messages.doc
+ doc/gtut-tour-12-staticstruct.doc
+ doc/gtut-tour-13-pointers.doc
+ doc/gtut-tour-14-dynar.doc
+ doc/gtut-tour-15-manualdatadef.doc
+ doc/gtut-tour-16-exchangecb.doc
)
+
foreach(file_name ${LISTE_GTUT})
file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
@@ -175,7 +206,8 @@ foreach(file_name ${LISTE_GTUT})
string(REGEX MATCH "Table of Contents.*
" valeur_line "${file_content}")
string(REPLACE "\n" ";" valeur_line "${valeur_line}")
string(REPLACE "\n" ";" file_content "${file_content}")
-
+
+ file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "\n") # make sure it exists
foreach(line ${file_content})
string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
string(REGEX MATCH ".*_toc.*" line3 "${line}")
@@ -191,6 +223,7 @@ foreach(file_name ${LISTE_GTUT})
endif(line2 AND NOT line3)
endforeach(line ${file_content})
+ file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "\n") # make sure it exists
foreach(line ${valeur_line})
string(REGEX MATCH ".*ref.*" line_ok ${line})
if(line_ok)
@@ -257,3 +290,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)