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(_name ${_infile} NAME)
  48   string(REPLACE ".xml" ".html" _outname ${_name})
  49   set(_outfile ${CMAKE_CURRENT_BINARY_DIR}/${_outname})
  50
  51   if (EXISTS ${_sources})
  52           if (MEINPROC4_EXECUTABLE)
  53                   ADD_CUSTOM_TARGET(${_outname} ALL
  54                         ${MEINPROC4_EXECUTABLE} --stylesheet ${STYLESHEET} -o ${_outfile} ${_infile}
  55                         DEPENDS ${_infile}
  56                         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
  57                 )
  58           endif ()
  59           if (XMLTO_EXECUTABLE)
  60                   ADD_CUSTOM_TARGET(${_outname} ALL
  61                         ${XMLTO_EXECUTABLE} -vv ${_options} ${_infile}
  62                         DEPENDS ${_infile}
  63                         WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
  64                 )
  65           endif ()
  66           install(FILES ${_outfile} DESTINATION share/doc/dbus)
  67   else ()
  68           MESSAGE(STATUS "skipping xml doc generating for ${_infile}, file not found")
  69   endif ()
  70
  71 endmacro (DOCBOOK)
  72
  73 ### copy tests to builddir so that generated tests and static tests
  74 ### are all in one place.
  75 ### todo how to add more filetypes
  76 MACRO (COPYDIR _src _type)
  77     FOREACH(FILE_TYPE ${_type})
  78         FOREACH(DIR ${_src})
  79                 FILE(GLOB FILES "${CMAKE_SOURCE_DIR}/../${DIR}/${FILE_TYPE}" )
  80                 FILE(MAKE_DIRECTORY ${CMAKE_BINARY_DIR}/${DIR})
  81                 FOREACH(FILE ${FILES})
  82                         GET_FILENAME_COMPONENT(FILENAME ${FILE} NAME)
  83                         SET (TARGET ${CMAKE_BINARY_DIR}/${DIR}/${FILENAME})
  84                         configure_file(${FILE} ${TARGET} COPYONLY)
  85                         IF (CONFIG_VERBOSE)
  86                                 MESSAGE("FROM: ${FILE}\nTO: ${TARGET}\n")
  87                         ENDIF (CONFIG_VERBOSE)
  88                 ENDFOREACH(FILE)
  89         ENDFOREACH(DIR)
  90     ENDFOREACH(FILE_TYPE)
  91 ENDMACRO (COPYDIR)
  92
  93 COPYDIR(doc *.png)
  94 COPYDIR(doc *.svg)
  95
  96 DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-test-plan.xml html-nochunks)
  97 DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-tutorial.xml html-nochunks)
  98 DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-specification.xml html-nochunks)
  99 DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-faq.xml html-nochunks)
 100 configure_file(${CMAKE_SOURCE_DIR}/../doc/dbus-daemon.1.xml.in ${CMAKE_BINARY_DIR}/doc/dbus-daemon.1.xml)
 101 DOCBOOK(${CMAKE_BINARY_DIR}/doc/dbus-daemon.1.xml html-nochunks)
 102 DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-monitor.1.xml html-nochunks)
 103 DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-send.1.xml html-nochunks)
 104 DOCBOOK(${CMAKE_SOURCE_DIR}/../doc/dbus-launch.1.xml html-nochunks)
 105
 106 #
 107 # handle html index file
 108 #
 109 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/index.html.cmake ${CMAKE_CURRENT_BINARY_DIR}/index.html )
 110 install(FILES ${CMAKE_CURRENT_BINARY_DIR}/index.html DESTINATION share/doc/dbus)
 111
 112 set (EXTRA_DIST
 113         ${CMAKE_SOURCE_DIR}/../doc/busconfig.dtd
 114         ${CMAKE_SOURCE_DIR}/../doc/introspect.dtd
 115         ${CMAKE_SOURCE_DIR}/../doc/introspect.xsl
 116 )
 117
 118 install(FILES ${EXTRA_DIST} DESTINATION share/doc/dbus)
 119
 120 endif(DBUS_ENABLE_XML_DOCS)