CMakeLists.txt 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. find_package(Sphinx)
  2. find_package(LATEX)
  3. set(DOC_LATEX_DIR ${PROJECT_BINARY_DIR}/doc_latex)
  4. set(DOC_HTML_DIR ${PROJECT_BINARY_DIR}/doc)
  5. set(DOC_SRC_DIR ${PROJECT_BINARY_DIR}/doc_src)
  6. make_directory(${DOC_SRC_DIR})
  7. # Copy all files from /doc dir to the /doc_src dir. doc_src is used to compile the documentation.
  8. # Use custom copy command to make sure files are correctly updated when they are changed.
  9. file(GLOB DOC_SRC "${PROJECT_SOURCE_DIR}/doc/*")
  10. list(REMOVE_ITEM DOC_SRC "${PROJECT_SOURCE_DIR}/doc/conf.py")
  11. list(REMOVE_ITEM DOC_SRC "${PROJECT_SOURCE_DIR}/doc/CMakeLists.txt")
  12. string(REPLACE "${PROJECT_SOURCE_DIR}/doc" "${DOC_SRC_DIR}" DOC_TARGET "${DOC_SRC}")
  13. file(COPY ${DOC_SRC} DESTINATION ${DOC_SRC_DIR})
  14. configure_file("${PROJECT_SOURCE_DIR}/doc/conf.py" "${DOC_SRC_DIR}/conf.py")
  15. list(APPEND GENERATED_RST "")
  16. macro(generate_rst in out)
  17. add_custom_command(OUTPUT ${out}
  18. DEPENDS ${PROJECT_SOURCE_DIR}/tools/c2rst.py ${in}
  19. PRE_BUILD
  20. COMMAND ${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/tools/c2rst.py ${in} ${out})
  21. list(APPEND GENERATED_RST "${out}")
  22. endmacro()
  23. # Doc from headers
  24. generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/types.h ${DOC_SRC_DIR}/types.rst)
  25. generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/constants.h ${DOC_SRC_DIR}/constants.rst)
  26. generate_rst(${PROJECT_BINARY_DIR}/src_generated/open62541/statuscodes.h ${DOC_SRC_DIR}/statuscodes.rst)
  27. generate_rst(${PROJECT_BINARY_DIR}/src_generated/open62541/types_generated.h ${DOC_SRC_DIR}/types_generated.rst)
  28. generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/server_config.h ${DOC_SRC_DIR}/server_config.rst)
  29. generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/server.h ${DOC_SRC_DIR}/server.rst)
  30. generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/client_config.h ${DOC_SRC_DIR}/client_config.rst)
  31. generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/client_subscriptions.h ${DOC_SRC_DIR}/client_subscriptions.rst)
  32. generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/client.h ${DOC_SRC_DIR}/client.rst)
  33. generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/client_highlevel.h ${DOC_SRC_DIR}/client_highlevel.rst)
  34. generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/plugin/log.h ${DOC_SRC_DIR}/plugin_log.rst)
  35. generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/plugin/network.h ${DOC_SRC_DIR}/plugin_network.rst)
  36. generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/plugin/accesscontrol.h ${DOC_SRC_DIR}/plugin_accesscontrol.rst)
  37. generate_rst(${PROJECT_SOURCE_DIR}/src/server/ua_services.h ${DOC_SRC_DIR}/services.rst)
  38. generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/plugin/nodestore.h ${DOC_SRC_DIR}/nodestore.rst)
  39. generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/plugin/pubsub.h ${DOC_SRC_DIR}/plugin_pubsub_connection.rst)
  40. generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/server_pubsub.h ${DOC_SRC_DIR}/pubsub.rst)
  41. # Doc from tutorial code
  42. generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_datatypes.c ${DOC_SRC_DIR}/tutorial_datatypes.rst)
  43. generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_firststeps.c ${DOC_SRC_DIR}/tutorial_server_firststeps.rst)
  44. generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_variable.c ${DOC_SRC_DIR}/tutorial_server_variable.rst)
  45. generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_variabletype.c ${DOC_SRC_DIR}/tutorial_server_variabletype.rst)
  46. generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_datasource.c ${DOC_SRC_DIR}/tutorial_server_datasource.rst)
  47. generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_events.c ${DOC_SRC_DIR}/tutorial_server_events.rst)
  48. generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_monitoreditems.c ${DOC_SRC_DIR}/tutorial_server_monitoreditems.rst)
  49. generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_object.c ${DOC_SRC_DIR}/tutorial_server_object.rst)
  50. generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_method.c ${DOC_SRC_DIR}/tutorial_server_method.rst)
  51. generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_client_firststeps.c ${DOC_SRC_DIR}/tutorial_client_firststeps.rst)
  52. generate_rst(${PROJECT_SOURCE_DIR}/examples/pubsub/tutorial_pubsub_publish.c ${DOC_SRC_DIR}/tutorial_pubsub_publish.rst)
  53. # Doc targets
  54. add_custom_target(doc_latex ${SPHINX_EXECUTABLE}
  55. -b latex "${DOC_SRC_DIR}" "${DOC_LATEX_DIR}"
  56. DEPENDS ${GENERATED_RST} ${DOC_TARGET}
  57. COMMENT "Building LaTeX sources for documentation with Sphinx")
  58. add_dependencies(doc_latex open62541)
  59. add_custom_target(doc_pdf ${PDFLATEX_COMPILER} -interaction=batchmode "open62541.tex"
  60. WORKING_DIRECTORY ${DOC_LATEX_DIR}
  61. # compile it twice so that the contents pages are correct
  62. COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode "open62541.tex"
  63. DEPENDS ${PDFLATEX_COMPILER}
  64. COMMENT "Generating PDF documentation from LaTeX sources")
  65. add_dependencies(doc_pdf doc_latex)
  66. add_custom_target(doc ${SPHINX_EXECUTABLE}
  67. -b html "${DOC_SRC_DIR}" "${DOC_HTML_DIR}"
  68. DEPENDS ${GENERATED_RST} ${DOC_TARGET}
  69. COMMENT "Building HTML documentation with Sphinx")
  70. add_dependencies(doc open62541)
  71. set_target_properties(doc doc_latex doc_pdf PROPERTIES EXCLUDE_FROM_DEFAULT_BUILD TRUE)
  72. set_target_properties(doc doc_latex doc_pdf PROPERTIES FOLDER "open62541/doc")
  73. if (UA_PACK_DEBIAN)
  74. set(open62541_install_debdoc_html_dir share/doc/open62541/open62541.html)
  75. set(open62541_install_debdoc_dir share/doc/open62541)
  76. set(open62541_debdoc_pdf_files "${DOC_LATEX_DIR}/open62541.pdf")
  77. install(DIRECTORY ${DOC_HTML_DIR}/
  78. COMPONENT htmldoc
  79. DESTINATION ${open62541_install_debdoc_dir}/open62541.html
  80. USE_SOURCE_PERMISSIONS
  81. FILES_MATCHING
  82. PATTERN "*.*"
  83. PATTERN "_sources" EXCLUDE
  84. PATTERN "CMakeFiles" EXCLUDE
  85. PATTERN "cmake_install.cmake" EXCLUDE
  86. )
  87. install(FILES ${open62541_debdoc_pdf_files} COMPONENT pdfdoc DESTINATION ${open62541_install_debdoc_dir})
  88. endif()