Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Prepare the target to make simgrid_documentation.pdf
[simgrid.git] / buildtools / Cmake / GenerateDoc.cmake
index 2809083..6703114 100644 (file)
@@ -1,3 +1,5 @@
+#### Generate the html documentation
+
 if(BIBTEX2HTML)
        set(BIBTEX2HTML_PATH ${BIBTEX2HTML})
 else(BIBTEX2HTML)
@@ -45,11 +47,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}
+               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/<IMG/<IMG style=border:0px/g' | ${CMAKE_HOME_DIRECTORY}/tools/doxygen/fig2dev_postprocessor.pl > ${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}
@@ -84,7 +88,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 index.doc gtut-introduction.doc installSimgrid.doc bindings.doc options.doc
                
                COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
                COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
@@ -92,7 +96,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 \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__GRAS__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html
@@ -108,28 +111,6 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV
                COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__SD__API.html'>DAG Simulator.</a></h2></center></html>\" >> ${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)
 
@@ -164,9 +145,27 @@ endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND IC
 ##############################################################################"
 
 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 +174,8 @@ foreach(file_name ${LISTE_GTUT})
        string(REGEX MATCH "Table of Contents.*<hr>" 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 +191,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 +258,58 @@ else(compare_files)
 endif(compare_files)   
   
 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
+
+#Website
+
+configure_file(${CMAKE_HOME_DIRECTORY}/website/Doxyfile_website.in ${CMAKE_HOME_DIRECTORY}/website/Doxyfile_website @ONLY)
+configure_file(${CMAKE_HOME_DIRECTORY}/website/index.php.in ${CMAKE_HOME_DIRECTORY}/website/html/index.php @ONLY)
+configure_file(${CMAKE_HOME_DIRECTORY}/website/documentation.php.in ${CMAKE_HOME_DIRECTORY}/website/html/documentation.php @ONLY)
+configure_file(${CMAKE_HOME_DIRECTORY}/website/download.php.in ${CMAKE_HOME_DIRECTORY}/website/html/download.php @ONLY)
+
+ADD_CUSTOM_TARGET(simgrid_website
+       COMMENT "Generating the SimGrid Website..."
+       DEPENDS ${WEBSITE_SOURCES} ${CMAKE_HOME_DIRECTORY}/website/all.bib
+       COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl FAQ.doc contrib.doc history.doc                             
+       COMMAND ${CMAKE_COMMAND} -E echo "XX Doxygen website pass"
+       COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile_website
+               
+       COMMAND ${CMAKE_COMMAND} -E echo "XX Post-processing Doxygen website result"
+       COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/doxygen_postprocesser_website.pl
+
+       COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_HOME_DIRECTORY}/website/stylesheets/ ${CMAKE_HOME_DIRECTORY}/website/html/stylesheets/
+       COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_HOME_DIRECTORY}/website/logos/ ${CMAKE_HOME_DIRECTORY}/website/html/logos/
+       COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_HOME_DIRECTORY}/website/img/ ${CMAKE_HOME_DIRECTORY}/website/html/img/
+       COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/website/documentation.html ${CMAKE_HOME_DIRECTORY}/website/html/documentation.html
+       
+       COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/website/html/index.html
+
+       WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/website/
+)
+
+ADD_CUSTOM_TARGET(bib_files
+       DEPENDS ${CMAKE_HOME_DIRECTORY}/website/all.bib
+       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}/website/all.bib > ${CMAKE_HOME_DIRECTORY}/website/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}/website/
+)
+
+add_dependencies(simgrid_website bib_files)
+
+ADD_CUSTOM_TARGET(pdf
+    COMMAND ${CMAKE_COMMAND} -E echo "XX Generate simgrid_documentation.pdf"
+    COMMAND make clean
+    COMMAND make 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)