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
88
|
# CMakeLists for documentation
find_program (XMLTO xmlto)
mark_as_advanced (XMLTO)
if (XMLTO STREQUAL "")
message (FATAL_ERROR "Xmlto was not found! Please install it to continue!")
endif (XMLTO STREQUAL "")
include (${CMAKE_SOURCE_DIR}/data/cmake/documentation.cmake)
add_xml_manpages(doc-man-asi "sources/man/appstream-index.1" "" "")
add_xml_manpages(doc-man-asv "sources/man/appstream-validate.1" "" "")
if (DOCUMENTATION)
#########################
# General project documentation
find_program (PUBLICAN publican)
mark_as_advanced (PUBLICAN)
if (PUBLICAN STREQUAL "")
message (FATAL_ERROR "Publican was not found. Please install it to continue!")
endif (PUBLICAN STREQUAL "")
# we need to assemble our documentation build-directory before we can built it
add_custom_target (assemble-docs
COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/prepare-docbuild.sh" "source_dir=${CMAKE_CURRENT_SOURCE_DIR}" "build_dir=${CMAKE_BINARY_DIR}/docbuild"
DEPENDS "publican.cfg"
"sources/"
"${CMAKE_BINARY_DIR}/docbuild/"
appstream
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
VERBATIM
)
# the actual target to build all documentation
add_custom_target (documentation-noexport
COMMAND ${PUBLICAN} "build" "--langs=en-US" "--publish" "--formats=html"
DEPENDS "publican.cfg"
"${CMAKE_BINARY_DIR}/docbuild/publican.cfg"
assemble-docs
doc-appstream
WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/docbuild/
)
add_custom_command (OUTPUT "${CMAKE_BINARY_DIR}/docbuild/"
COMMAND ${CMAKE_COMMAND} -E make_directory "${CMAKE_BINARY_DIR}/docbuild"
VERBATIM
)
set_directory_properties (PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES ${CMAKE_CURRENT_SOURCE_DIR}/html)
set_directory_properties (PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES ${CMAKE_BINARY_DIR}/docbuild)
# a target to export documentation html to the source tree (useful when building the tarballs)
add_custom_target (documentation
COMMAND ${CMAKE_COMMAND} -E copy_directory "${CMAKE_BINARY_DIR}/docbuild/AppStream-Docs/en-US/html/" "${CMAKE_CURRENT_SOURCE_DIR}/html"
DEPENDS documentation-noexport
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)
add_custom_command(
TARGET documentation POST_BUILD
COMMAND ${CMAKE_COMMAND} -E copy_directory "${CMAKE_CURRENT_SOURCE_DIR}/api/html" "${CMAKE_CURRENT_SOURCE_DIR}/html/api/html"
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
)
#########################
# API documentation
find_package(GtkDoc)
if(NOT GTKDOC_FOUND)
message(FATAL_ERROR "gtkdoc was not found, API documentation can not be built.")
endif()
include(UseGtkDoc)
gtk_doc_add_module(appstream ${CMAKE_SOURCE_DIR}/src
IGNOREHEADERS as-component-private.h as-utils.h as-database-write.h as-settings-private.h
SUFFIXES h c hh cc
LDFLAGS
-L${CMAKE_CURRENT_BINARY_DIR}/../src
-lappstream
LDPATH
"${CMAKE_CURRENT_BINARY_DIR}/../src"
OUTPUT_DIR
"${CMAKE_CURRENT_SOURCE_DIR}/api"
DEPENDS appstream)
set_directory_properties (PROPERTIES CLEAN_NO_CUSTOM ${CMAKE_CURRENT_SOURCE_DIR}/api)
set_directory_properties (PROPERTIES ADDITIONAL_MAKE_CLEAN_FILES "${CMAKE_CURRENT_SOURCE_DIR}/api/html;${CMAKE_CURRENT_SOURCE_DIR}/api/xml;${CMAKE_CURRENT_SOURCE_DIR}/api/tmpl")
install(DIRECTORY html/api/html/ DESTINATION share/gtk-doc/html/appstream)
endif()
|
