1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
if(ENABLE_DOCS)
add_custom_target(docs ALL
COMMENT "Generating documentation and manuals in HTML format"
)
if(DOXYGEN_FOUND)
# set input and output files
set(DOXYGEN_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
set(DOXYGEN_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
# configure for graphviz
set(DOXYGEN_DIAGRAM "NO")
if(DOXYGEN_DOT_FOUND)
set(DOXYGEN_DIAGRAM "YES")
endif()
# request to configure the file
configure_file(${DOXYGEN_IN} ${DOXYGEN_OUT} @ONLY)
# note the option ALL which allows to build the docs together with the application
add_custom_command(
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/html"
DEPENDS ${DOXYGEN_OUT}
COMMAND "${DOXYGEN_EXECUTABLE}" "${DOXYGEN_OUT}"
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
COMMENT "Generating API documentation with Doxygen"
)
add_custom_target(
doxygen_docs
DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/html"
)
add_dependencies(docs doxygen_docs)
install(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html"
DESTINATION "${CMAKE_INSTALL_DOCDIR}"
)
endif()
if(ASCIIDOC_EXECUTABLE)
add_custom_command(
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/manual/manual.html"
DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/manual/manual.adoc" "${CMAKE_CURRENT_SOURCE_DIR}/manual/images"
COMMAND ${CMAKE_COMMAND} -E make_directory "${CMAKE_CURRENT_BINARY_DIR}/manual"
COMMAND "${ASCIIDOC_EXECUTABLE}" -b html5 -o "${CMAKE_CURRENT_BINARY_DIR}/manual/manual.html" "${CMAKE_CURRENT_SOURCE_DIR}/manual/manual.adoc"
COMMAND ${CMAKE_COMMAND} -E copy_directory "${CMAKE_CURRENT_SOURCE_DIR}/manual/images" "${CMAKE_CURRENT_BINARY_DIR}/manual/images"
COMMENT "Generating OpenSCAP User Manual in HTML format"
)
add_custom_target(
user_manual
DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/manual/manual.html"
)
install(DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/manual"
DESTINATION "${CMAKE_INSTALL_DOCDIR}"
)
add_custom_command(
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/developer/developer.html"
DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/developer/developer.adoc"
COMMAND ${CMAKE_COMMAND} -E make_directory "${CMAKE_CURRENT_BINARY_DIR}/developer"
COMMAND "${ASCIIDOC_EXECUTABLE}" -b html5 -o "${CMAKE_CURRENT_BINARY_DIR}/developer/developer.html" "${CMAKE_CURRENT_SOURCE_DIR}/developer/developer.adoc"
COMMENT "Generating OpenSCAP Developer Manual in HTML format"
)
add_custom_target(
developer_manual
DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/developer/developer.html"
)
# We are not installing the OpenSCAP Developer manual because it does not
# make any sense to install this for end-users.
add_custom_command(
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/contribute/contribute.html" "${CMAKE_CURRENT_BINARY_DIR}/contribute/testing.html" "${CMAKE_CURRENT_BINARY_DIR}/contribute/versioning.html"
DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/contribute/contribute.adoc" "${CMAKE_CURRENT_SOURCE_DIR}/contribute/testing.adoc" "${CMAKE_CURRENT_SOURCE_DIR}/contribute/versioning.adoc"
COMMAND ${CMAKE_COMMAND} -E make_directory "${CMAKE_CURRENT_BINARY_DIR}/contribute"
COMMAND "${ASCIIDOC_EXECUTABLE}" -b html5 -o "${CMAKE_CURRENT_BINARY_DIR}/contribute/contribute.html" "${CMAKE_CURRENT_SOURCE_DIR}/contribute/contribute.adoc"
COMMAND "${ASCIIDOC_EXECUTABLE}" -b html5 -o "${CMAKE_CURRENT_BINARY_DIR}/contribute/testing.html" "${CMAKE_CURRENT_SOURCE_DIR}/contribute/testing.adoc"
COMMAND "${ASCIIDOC_EXECUTABLE}" -b html5 -o "${CMAKE_CURRENT_BINARY_DIR}/contribute/versioning.html" "${CMAKE_CURRENT_SOURCE_DIR}/contribute/versioning.adoc"
COMMENT "Generating contribute documentation in HTML format"
)
add_custom_target(
contribute_docs
DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/contribute/contribute.html" "${CMAKE_CURRENT_BINARY_DIR}/contribute/testing.html" "${CMAKE_CURRENT_BINARY_DIR}/contribute/versioning.html"
)
# We are not installing the contribute documentation because it does not
# make any sense to install this for end-users.
add_dependencies(docs user_manual developer_manual contribute_docs)
endif()
endif()
|
