2 ### Generate all parts of the documentation on non-Windows systems
4 ### - HTML with doxygen (reference and manual)
5 ### - Javadoc (reference)
6 ### - manpages (reference of tools)
8 ### This file is not loaded on windows
10 #### Generate the html documentation
11 if (enable_documentation)
12 find_package(Doxygen REQUIRED)
17 find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS)
19 if(enable_documentation)
20 ADD_CUSTOM_TARGET(documentation
21 COMMENT "Generating the SimGrid documentation..."
22 DEPENDS ${DOC_SOURCES} ${source_doxygen}
23 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/doc/doxygen
24 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/doc/example_lists
25 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_BINARY_DIR}/doc/html
26 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/doc/html
27 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_BINARY_DIR}/doc/xml
28 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_BINARY_DIR}/docs/source/api
29 WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
32 message(STATUS "Doxygen version: ${DOXYGEN_VERSION}")
34 # This is a workaround for older cmake versions (such as 2.8.7 on Ubuntu 12.04). These cmake versions do not provide
35 # the DOXYGEN_VERSION variable and hence, building the documentation will always fail. This code is the same as used
36 # in the cmake library, version 3.
37 if(DOXYGEN_EXECUTABLE)
38 execute_process(COMMAND ${DOXYGEN_EXECUTABLE} "--version" OUTPUT_VARIABLE DOXYGEN_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE)
41 if(DOXYGEN_VERSION VERSION_LESS "1.8")
42 ADD_CUSTOM_TARGET(error_doxygen
43 COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation. Version found: ${DOXYGEN_VERSION}"
46 add_dependencies(documentation error_doxygen)
49 configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_BINARY_DIR}/doc/Doxyfile @ONLY)
51 foreach(file ${DOC_IMG})
52 ADD_CUSTOM_COMMAND(TARGET documentation COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_BINARY_DIR}/doc/html/)
55 ADD_CUSTOM_COMMAND(TARGET documentation
57 COMMAND ${CMAKE_COMMAND} -E echo "XX Generate list of files in examples/ for routing models"
58 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/doc/example_lists/
59 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh Floyd > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_floyd
60 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh Dijkstra > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_dijkstra
61 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh DijkstraCache > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_dijkstra_cache
62 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="None"' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_none
63 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="Cluster"' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_cluster
64 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="Vivaldi"' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_vivaldi
65 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="Full"' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_full
66 COMMAND ${CMAKE_COMMAND} -E echo "XX Generate list of files in examples/ for XML tags"
67 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh '<mount ' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_xmltag_mount
68 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh '<link_ctn ' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_xmltag_linkctn
69 COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen"
70 COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile
71 WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
74 ### Fill in the "make gforge-sync" target ###
76 set(RSYNC_CMD rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --times --omit-dir-times --perms --chmod=a+rX,ug+w,o-w,Dg+s)
78 add_custom_target(gforge-sync
79 COMMAND ssh scm.gforge.inria.fr mkdir -p -m 2775 /home/groups/simgrid/htdocs/simgrid/${release_version}/ || true
81 COMMAND ${RSYNC_CMD} doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true
83 COMMAND ${RSYNC_CMD} /${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
84 /${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/
86 COMMAND ${RSYNC_CMD} ${CMAKE_HOME_DIRECTORY}/src/surf/xml/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/
87 COMMAND ${RSYNC_CMD} ${CMAKE_HOME_DIRECTORY}/src/surf/xml/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/simgrid.dtd
89 WORKING_DIRECTORY "${CMAKE_BINARY_DIR}"
91 add_dependencies(gforge-sync documentation)
94 find_path(JAVADOC_PATH NAMES javadoc PATHS NO_DEFAULT_PATHS)
95 mark_as_advanced(JAVADOC_PATH)
97 ADD_CUSTOM_COMMAND(TARGET documentation
98 COMMAND ${CMAKE_COMMAND} -E echo "XX Javadoc pass"
99 COMMAND ${JAVADOC_PATH}/javadoc -quiet -d ${CMAKE_BINARY_DIR}/doc/html/javadoc/ ${CMAKE_HOME_DIRECTORY}/src/bindings/java/org/simgrid/*.java ${CMAKE_HOME_DIRECTORY}/src/bindings/java/org/simgrid/*/*.java
100 WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
104 #### Generate the manpages
106 set( MANPAGE_DIR ${CMAKE_BINARY_DIR}/manpages )
109 add_custom_target(manpages ALL
110 COMMAND ${CMAKE_COMMAND} -E make_directory ${MANPAGE_DIR}
111 COMMAND pod2man ${CMAKE_HOME_DIRECTORY}/tools/simgrid_update_xml.pl > ${MANPAGE_DIR}/simgrid_update_xml.1
112 COMMAND pod2man ${CMAKE_HOME_DIRECTORY}/docs/manpages/tesh.pod > ${MANPAGE_DIR}/tesh.1
113 COMMENT "Generating manpages"
116 ${MANPAGE_DIR}/simgrid_update_xml.1
117 ${MANPAGE_DIR}/tesh.1
118 ${CMAKE_HOME_DIRECTORY}/docs/manpages/smpicc.1
119 ${CMAKE_HOME_DIRECTORY}/docs/manpages/smpicxx.1
120 ${CMAKE_HOME_DIRECTORY}/docs/manpages/smpif90.1
121 ${CMAKE_HOME_DIRECTORY}/docs/manpages/smpiff.1
122 ${CMAKE_HOME_DIRECTORY}/docs/manpages/smpirun.1
123 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1
126 else(enable_documentation)
127 ADD_CUSTOM_TARGET(documentation
128 COMMENT "The generation of the SimGrid documentation was disabled in cmake"
130 endif(enable_documentation)