cmake/doc/CMakeLists.txt

   1 find_package(Doxygen)
   2
   3 if(DOXYGEN_EXECUTABLE)
   4   OPTION(DBUS_ENABLE_DOXYGEN_DOCS "build DOXYGEN documentation (requires Doxygen)" ON)
   5 endif(DOXYGEN_EXECUTABLE)
   6
   7 if (DBUS_ENABLE_DOXYGEN_DOCS)
   8     set (top_srcdir ${CMAKE_SOURCE_DIR}/..)
   9     configure_file(${CMAKE_SOURCE_DIR}/Doxyfile.cmake ${CMAKE_BINARY_DIR}/Doxyfile )
  10     add_custom_target(doc
  11         COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/Doxyfile
  12     )
  13 endif (DBUS_ENABLE_DOXYGEN_DOCS)
  14
  15 #
  16 # find docbook generator
  17 #
  18 find_program(MEINPROC4_EXECUTABLE meinproc4)
  19
  20 find_program(XMLTO_EXECUTABLE xmlto)
  21
  22 if (MEINPROC4_EXECUTABLE OR XMLTO_EXECUTABLE)
  23   OPTION(DBUS_ENABLE_XML_DOCS "build XML  documentation (requires xmlto or meinproc4)" ON)
  24 endif (MEINPROC4_EXECUTABLE OR XMLTO_EXECUTABLE)
  25
  26 if (XMLTO_EXECUTABLE)
  27         set (DOCBOOK_GENERATOR_NAME "xmlto" PARENT_SCOPE)
  28         set(DBUS_XML_DOCS_ENABLED 1)
  29         set(MEINPROC4_EXECUTABLE 0)
  30         MESSAGE(STATUS "xmlto docbook generator found")
  31 elseif (MEINPROC4_EXECUTABLE)
  32         set(DOCBOOK_GENERATOR_NAME "meinproc4" PARENT_SCOPE)
  33         set(DBUS_XML_DOCS_ENABLED 1)
  34         if(WIN32)
  35                 get_filename_component(_a ${MEINPROC4_EXECUTABLE} PATH)
  36                 get_filename_component(_meinproc_install_path ${_a} PATH)
  37         else(WIN32)
  38                 set(_meinproc_install_path ${CMAKE_INSTALL_PREFIX})
  39         endif(WIN32)
  40         set(STYLESHEET "${_meinproc_install_path}/share/apps/ksgmltools2/docbook/xsl/html/docbook.xsl")
  41 endif ()
  42
  43 if (DBUS_ENABLE_XML_DOCS)
  44
  45 macro (DOCBOOK _sources _options)
  46   get_filename_component(_infile ${_sources} ABSOLUTE)
  47   get_filename_component(_basename ${_infile} NAME_WE)
  48   set(_outfile ${CMAKE_CURRENT_BINARY_DIR}/${_basename}.html)
  49
  50   if (EXISTS ${_sources})
  51           if (MEINPROC4_EXECUTABLE)
  52                   ADD_CUSTOM_TARGET(${_basename}.html ALL
  53                         ${MEINPROC4_EXECUTABLE} --stylesheet ${STYLESHEET} -o ${_outfile} ${_infile}
  54                         DEPENDS ${_infile}
  55                         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
  56                 )
  57           endif ()
  58           if (XMLTO_EXECUTABLE)
  59                   ADD_CUSTOM_TARGET(${_basename}.html ALL
  60                         ${XMLTO_EXECUTABLE} -vv ${_options} ${_infile}
  61                         DEPENDS ${_infile}
  62                         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
  63                 )
  64           endif ()
  65           install(FILES ${_outfile} DESTINATION share/doc/dbus)
  66   else ()
  67           MESSAGE(STATUS "skipping xml doc generating for ${_infile}, file not found")
  68   endif ()
  69
  70 endmacro (DOCBOOK)
  71
  72 ### copy tests to builddir so that generated tests and static tests
  73 ### are all in one place.
  74 ### todo how to add more filetypes
  75 MACRO (COPYDIR _src _type)
  76     FOREACH(FILE_TYPE ${_type})
  77         FOREACH(DIR ${_src})
  78                 FILE(GLOB FILES "${CMAKE_SOURCE_DIR}/../${DIR}/${FILE_TYPE}" )
  79                 FILE(MAKE_DIRECTORY ${CMAKE_BINARY_DIR}/${DIR})
  80                 FOREACH(FILE ${FILES})
  81                         GET_FILENAME_COMPONENT(FILENAME ${FILE} NAME)
  82                         SET (TARGET ${CMAKE_BINARY_DIR}/${DIR}/${FILENAME})
  83                         configure_file(${FILE} ${TARGET} COPYONLY)
  84                         IF (CONFIG_VERBOSE)
  85                                 MESSAGE("FROM: ${FILE}\nTO: ${TARGET}\n")
  86                         ENDIF (CONFIG_VERBOSE)
  87                 ENDFOREACH(FILE)
  88         ENDFOREACH(DIR)
  89     ENDFOREACH(FILE_TYPE)
  90 ENDMACRO (COPYDIR)
  91
  92 COPYDIR(doc *.png)
  93 COPYDIR(doc *.svg)
  94
  95 DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-test-plan.xml html-nochunks)
  96 DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-tutorial.xml html-nochunks)
  97 DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-specification.xml html-nochunks)
  98 DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-faq.xml html-nochunks)
  99 DOCBOOK(${CMAKE_SOURCE_DIR}/bus/dbus-daemon.xml html-nochunks)
 100 DOCBOOK(${CMAKE_SOURCE_DIR}/tools/dbus-monitor.xml html-nochunks)
 101 DOCBOOK(${CMAKE_SOURCE_DIR}/tools/dbus-send.xml html-nochunks)
 102 DOCBOOK(${CMAKE_SOURCE_DIR}/tools/dbus-launch.xml html-nochunks)
 103
 104 #
 105 # handle html index file
 106 #
 107 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/index.html.cmake ${CMAKE_CURRENT_BINARY_DIR}/index.html )
 108 install(FILES ${CMAKE_CURRENT_BINARY_DIR}/index.html DESTINATION share/doc/dbus)
 109
 110 set (EXTRA_DIST
 111         ${CMAKE_SOURCE_DIR}/../doc/busconfig.dtd
 112         ${CMAKE_SOURCE_DIR}/../doc/introspect.dtd
 113         ${CMAKE_SOURCE_DIR}/../doc/introspect.xsl
 114 )
 115
 116 install(FILES ${EXTRA_DIST} DESTINATION share/doc/dbus)
 117
 118 endif(DBUS_ENABLE_XML_DOCS)