mirror of
https://github.com/open62541/open62541.git
synced 2025-06-03 04:00:21 +00:00
119 lines
7.6 KiB
CMake
119 lines
7.6 KiB
CMake
find_package(Sphinx)
|
|
find_package(LATEX)
|
|
|
|
set(DOC_LATEX_DIR ${PROJECT_BINARY_DIR}/doc_latex)
|
|
set(DOC_HTML_DIR ${PROJECT_BINARY_DIR}/doc)
|
|
set(DOC_SRC_DIR ${PROJECT_BINARY_DIR}/doc_src)
|
|
|
|
make_directory(${DOC_SRC_DIR})
|
|
|
|
# Copy all files from /doc dir to the /doc_src dir. doc_src is used to compile the documentation.
|
|
# Use custom copy command to make sure files are correctly updated when they are changed.
|
|
file(GLOB DOC_SRC "${PROJECT_SOURCE_DIR}/doc/*")
|
|
list(REMOVE_ITEM DOC_SRC "${PROJECT_SOURCE_DIR}/doc/conf.py")
|
|
list(REMOVE_ITEM DOC_SRC "${PROJECT_SOURCE_DIR}/doc/CMakeLists.txt")
|
|
string(REPLACE "${PROJECT_SOURCE_DIR}/doc" "${DOC_SRC_DIR}" DOC_TARGET "${DOC_SRC}")
|
|
file(COPY ${DOC_SRC} DESTINATION ${DOC_SRC_DIR})
|
|
|
|
configure_file("${PROJECT_SOURCE_DIR}/doc/conf.py" "${DOC_SRC_DIR}/conf.py")
|
|
|
|
list(APPEND GENERATED_RST "")
|
|
|
|
# Generated type definitions
|
|
add_custom_command(OUTPUT ${DOC_SRC_DIR}/types_generated.rst
|
|
COMMAND ${CMAKE_COMMAND} -E copy ${PROJECT_BINARY_DIR}/src_generated/open62541/types_generated.rst ${DOC_SRC_DIR}
|
|
DEPENDS ${PROJECT_BINARY_DIR}/src_generated/open62541/types_generated.rst)
|
|
list(APPEND GENERATED_RST ${DOC_SRC_DIR}/types_generated.rst)
|
|
|
|
macro(generate_rst in out)
|
|
add_custom_command(OUTPUT ${out}
|
|
DEPENDS ${PROJECT_SOURCE_DIR}/tools/c2rst.py ${in}
|
|
COMMAND ${Python3_EXECUTABLE} ${PROJECT_SOURCE_DIR}/tools/c2rst.py ${in} ${out})
|
|
list(APPEND GENERATED_RST "${out}")
|
|
endmacro()
|
|
|
|
# Doc from headers
|
|
generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/types.h ${DOC_SRC_DIR}/types.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/common.h ${DOC_SRC_DIR}/common.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/util.h ${DOC_SRC_DIR}/util.rst)
|
|
generate_rst(${PROJECT_BINARY_DIR}/src_generated/open62541/statuscodes.h ${DOC_SRC_DIR}/statuscodes.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/server.h ${DOC_SRC_DIR}/server.rst)
|
|
|
|
# PubSub docs are concatendated from multiple files
|
|
add_custom_command(OUTPUT ${DOC_SRC_DIR}/pubsub.rst
|
|
DEPENDS ${PROJECT_SOURCE_DIR}/tools/c2rst.py
|
|
${PROJECT_SOURCE_DIR}/include/open62541/server_pubsub.h
|
|
${PROJECT_SOURCE_DIR}/include/open62541/pubsub.h
|
|
COMMAND ${Python3_EXECUTABLE} ${PROJECT_SOURCE_DIR}/tools/c2rst.py
|
|
${PROJECT_SOURCE_DIR}/include/open62541/server_pubsub.h
|
|
${PROJECT_SOURCE_DIR}/include/open62541/pubsub.h
|
|
${DOC_SRC_DIR}/pubsub.rst)
|
|
list(APPEND GENERATED_RST ${DOC_SRC_DIR}/pubsub.rst)
|
|
|
|
# Client docs are concatendated from multiple files
|
|
add_custom_command(OUTPUT ${DOC_SRC_DIR}/client.rst
|
|
DEPENDS ${PROJECT_SOURCE_DIR}/tools/c2rst.py
|
|
${PROJECT_SOURCE_DIR}/include/open62541/client.h
|
|
${PROJECT_SOURCE_DIR}/include/open62541/client_subscriptions.h
|
|
${PROJECT_SOURCE_DIR}/include/open62541/client_highlevel.h
|
|
${PROJECT_SOURCE_DIR}/include/open62541/client_highlevel_async.h
|
|
COMMAND ${Python3_EXECUTABLE} ${PROJECT_SOURCE_DIR}/tools/c2rst.py
|
|
${PROJECT_SOURCE_DIR}/include/open62541/client.h
|
|
${PROJECT_SOURCE_DIR}/include/open62541/client_subscriptions.h
|
|
${PROJECT_SOURCE_DIR}/include/open62541/client_highlevel.h
|
|
${PROJECT_SOURCE_DIR}/include/open62541/client_highlevel_async.h
|
|
${DOC_SRC_DIR}/client.rst)
|
|
list(APPEND GENERATED_RST ${DOC_SRC_DIR}/client.rst)
|
|
|
|
generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/plugin/accesscontrol.h ${DOC_SRC_DIR}/plugin_accesscontrol.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/plugin/log.h ${DOC_SRC_DIR}/plugin_log.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/plugin/nodestore.h ${DOC_SRC_DIR}/plugin_nodestore.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/plugin/eventloop.h ${DOC_SRC_DIR}/plugin_eventloop.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/plugin/certificategroup.h ${DOC_SRC_DIR}/plugin_certificategroup.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/include/open62541/plugin/securitypolicy.h ${DOC_SRC_DIR}/plugin_securitypolicy.rst)
|
|
|
|
# Doc from tutorial code
|
|
generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_datatypes.c ${DOC_SRC_DIR}/tutorial_datatypes.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_firststeps.c ${DOC_SRC_DIR}/tutorial_server_firststeps.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_variable.c ${DOC_SRC_DIR}/tutorial_server_variable.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_variabletype.c ${DOC_SRC_DIR}/tutorial_server_variabletype.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_datasource.c ${DOC_SRC_DIR}/tutorial_server_datasource.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_events.c ${DOC_SRC_DIR}/tutorial_server_events.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_alarms_conditions.c ${DOC_SRC_DIR}/tutorial_server_alarms_conditions.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_monitoreditems.c ${DOC_SRC_DIR}/tutorial_server_monitoreditems.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_object.c ${DOC_SRC_DIR}/tutorial_server_object.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_server_method.c ${DOC_SRC_DIR}/tutorial_server_method.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/examples/tutorial_client_firststeps.c ${DOC_SRC_DIR}/tutorial_client_firststeps.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/examples/pubsub/tutorial_pubsub_publish.c ${DOC_SRC_DIR}/tutorial_pubsub_publish.rst)
|
|
generate_rst(${PROJECT_SOURCE_DIR}/examples/pubsub/tutorial_pubsub_subscribe.c ${DOC_SRC_DIR}/tutorial_pubsub_subscribe.rst)
|
|
|
|
# generate_rst(${PROJECT_SOURCE_DIR}/examples/pubsub_realtime/pubsub_TSN_publisher.c ${DOC_SRC_DIR}/pubsub_TSN_publisher.rst)
|
|
# generate_rst(${PROJECT_SOURCE_DIR}/examples/pubsub_realtime/pubsub_TSN_loopback.c ${DOC_SRC_DIR}/pubsub_TSN_loopback.rst)
|
|
# generate_rst(${PROJECT_SOURCE_DIR}/examples/pubsub_realtime/nodeset/pubsub_nodeset_rt_publisher.c ${DOC_SRC_DIR}/pubsub_nodeset_rt_publisher.rst)
|
|
# generate_rst(${PROJECT_SOURCE_DIR}/examples/pubsub_realtime/nodeset/pubsub_nodeset_rt_subscriber.c ${DOC_SRC_DIR}/pubsub_nodeset_rt_subscriber.rst)
|
|
|
|
# Doc targets
|
|
|
|
add_custom_target(doc_latex ${SPHINX_EXECUTABLE}
|
|
-b latex "${DOC_SRC_DIR}" "${DOC_LATEX_DIR}"
|
|
DEPENDS ${GENERATED_RST} ${DOC_TARGET}
|
|
COMMENT "Building LaTeX sources for documentation with Sphinx")
|
|
add_dependencies(doc_latex open62541)
|
|
|
|
add_custom_target(doc_pdf ${PDFLATEX_COMPILER} -interaction=batchmode "open62541.tex"
|
|
WORKING_DIRECTORY ${DOC_LATEX_DIR}
|
|
# compile it twice so that the contents pages are correct
|
|
COMMAND ${PDFLATEX_COMPILER} -interaction=batchmode "open62541.tex"
|
|
DEPENDS ${PDFLATEX_COMPILER}
|
|
COMMENT "Generating PDF documentation from LaTeX sources")
|
|
add_dependencies(doc_pdf doc_latex)
|
|
|
|
add_custom_target(doc ${SPHINX_EXECUTABLE}
|
|
-b html "${DOC_SRC_DIR}" "${DOC_HTML_DIR}"
|
|
DEPENDS ${GENERATED_RST} ${DOC_TARGET}
|
|
COMMENT "Building HTML documentation with Sphinx")
|
|
add_dependencies(doc open62541)
|
|
|
|
set_target_properties(doc doc_latex doc_pdf PROPERTIES EXCLUDE_FROM_DEFAULT_BUILD TRUE)
|
|
set_target_properties(doc doc_latex doc_pdf PROPERTIES FOLDER "open62541/doc")
|