CMakeLists.txt 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. find_package(Sphinx REQUIRED)
  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. file(GLOB DOC_SRC "${PROJECT_SOURCE_DIR}/doc/*")
  8. list(REMOVE_ITEM DOC_SRC "${PROJECT_SOURCE_DIR}/doc/conf.py")
  9. list(REMOVE_ITEM DOC_SRC "${PROJECT_SOURCE_DIR}/doc/tutorial_server_variables.rst")
  10. list(REMOVE_ITEM DOC_SRC "${PROJECT_SOURCE_DIR}/doc/tutorial_server_method.rst")
  11. file(COPY ${DOC_SRC} DESTINATION ${DOC_SRC_DIR})
  12. configure_file("${PROJECT_SOURCE_DIR}/doc/conf.py" "${DOC_SRC_DIR}/conf.py")
  13. configure_file("${PROJECT_SOURCE_DIR}/doc/tutorial_server_variables.rst"
  14. "${DOC_SRC_DIR}/tutorial_server_variables.rst")
  15. configure_file("${PROJECT_SOURCE_DIR}/doc/tutorial_server_method.rst"
  16. "${DOC_SRC_DIR}/tutorial_server_method.rst")
  17. # Copy example code
  18. set(EXAMPLES ${PROJECT_SOURCE_DIR}/examples/server_variable.c
  19. ${PROJECT_SOURCE_DIR}/examples/server_method.c)
  20. file(COPY ${EXAMPLES} DESTINATION ${DOC_SRC_DIR})
  21. function(generate_rst in out)
  22. add_custom_command(OUTPUT ${out} DEPENDS ${PROJECT_SOURCE_DIR}/tools/c2rst.py ${in}
  23. PRE_BUILD COMMAND ${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/tools/c2rst.py ${in} ${out})
  24. endfunction()
  25. generate_rst(${PROJECT_SOURCE_DIR}/include/ua_types.h ${DOC_SRC_DIR}/types.rst)
  26. generate_rst(${PROJECT_SOURCE_DIR}/include/ua_constants.h ${DOC_SRC_DIR}/constants.rst)
  27. generate_rst(${PROJECT_BINARY_DIR}/src_generated/ua_types_generated.h ${DOC_SRC_DIR}/types_generated.rst)
  28. generate_rst(${PROJECT_SOURCE_DIR}/include/ua_server.h ${DOC_SRC_DIR}/server.rst)
  29. generate_rst(${PROJECT_SOURCE_DIR}/include/ua_client.h ${DOC_SRC_DIR}/client.rst)
  30. generate_rst(${PROJECT_SOURCE_DIR}/include/ua_client_highlevel.h ${DOC_SRC_DIR}/client_highlevel.rst)
  31. generate_rst(${PROJECT_SOURCE_DIR}/include/ua_log.h ${DOC_SRC_DIR}/log.rst)
  32. generate_rst(${PROJECT_SOURCE_DIR}/include/ua_connection.h ${DOC_SRC_DIR}/connection.rst)
  33. generate_rst(${PROJECT_SOURCE_DIR}/src/server/ua_services.h ${DOC_SRC_DIR}/services.rst)
  34. generate_rst(${PROJECT_SOURCE_DIR}/src/server/ua_nodestore.h ${DOC_SRC_DIR}/nodestore.rst)
  35. generate_rst(${PROJECT_SOURCE_DIR}/src/server/ua_nodes.h ${DOC_SRC_DIR}/information_modelling.rst)
  36. generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorials/client_firststeps.c
  37. ${DOC_SRC_DIR}/tutorial_client_firststeps.rst)
  38. generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorials/server_firststeps.c
  39. ${DOC_SRC_DIR}/tutorial_server_firststeps.rst)
  40. add_custom_target(doc_latex ${SPHINX_EXECUTABLE}
  41. -b latex "${DOC_SRC_DIR}" "${DOC_LATEX_DIR}"
  42. DEPENDS ${DOC_SRC_DIR}/types.rst ${DOC_SRC_DIR}/constants.rst ${DOC_SRC_DIR}/types_generated.rst
  43. ${DOC_SRC_DIR}/server.rst ${DOC_SRC_DIR}/client.rst ${DOC_SRC_DIR}/client_highlevel.rst
  44. ${DOC_SRC_DIR}/log.rst ${DOC_SRC_DIR}/connection.rst ${DOC_SRC_DIR}/services.rst
  45. ${DOC_SRC_DIR}/nodestore.rst ${DOC_SRC_DIR}/information_modelling.rst
  46. ${DOC_SRC_DIR}/protocol.rst
  47. ${DOC_SRC_DIR}/tutorial_server_firststeps.rst
  48. ${DOC_SRC_DIR}/tutorial_client_firststeps.rst
  49. COMMENT "Building LaTeX sources for documentation with Sphinx")
  50. add_dependencies(doc_latex open62541)
  51. add_custom_target(doc_pdf ${PDFLATEX_COMPILER} -q "open62541.tex"
  52. WORKING_DIRECTORY ${DOC_LATEX_DIR}
  53. # compile it twice so that the contents pages are correct
  54. COMMAND ${PDFLATEX_COMPILER} -q "open62541.tex"
  55. DEPENDS ${PDFLATEX_COMPILER}
  56. COMMENT "Generating PDF documentation from LaTeX sources")
  57. add_dependencies(doc_pdf doc_latex)
  58. add_custom_target(doc ${SPHINX_EXECUTABLE}
  59. -b html "${DOC_SRC_DIR}" "${DOC_HTML_DIR}"
  60. DEPENDS ${DOC_SRC_DIR}/types.rst ${DOC_SRC_DIR}/constants.rst ${DOC_SRC_DIR}/types_generated.rst
  61. ${DOC_SRC_DIR}/server.rst ${DOC_SRC_DIR}/client.rst ${DOC_SRC_DIR}/client_highlevel.rst
  62. ${DOC_SRC_DIR}/log.rst ${DOC_SRC_DIR}/connection.rst ${DOC_SRC_DIR}/services.rst
  63. ${DOC_SRC_DIR}/nodestore.rst ${DOC_SRC_DIR}/information_modelling.rst
  64. ${DOC_SRC_DIR}/protocol.rst
  65. ${DOC_SRC_DIR}/tutorial_server_firststeps.rst
  66. ${DOC_SRC_DIR}/tutorial_client_firststeps.rst
  67. COMMENT "Building HTML documentation with Sphinx")
  68. add_dependencies(doc open62541)