blob: bc87eb727d3223a38e310fcee78b3cf1949f545a [file] [log] [blame]
Michael Gottesman4d35b902013-08-24 07:25:21 +00001
Michael Gottesman4d35b902013-08-24 07:25:21 +00002if (DOXYGEN_FOUND)
3if (LLVM_ENABLE_DOXYGEN)
Vassil Vassilevd36820f2017-04-27 17:23:53 +00004 set(abs_top_srcdir ${CMAKE_CURRENT_SOURCE_DIR})
5 set(abs_top_builddir ${CMAKE_CURRENT_BINARY_DIR})
Jonas Devlieghere0203ac92017-11-02 17:12:34 +00006
Michael Gottesman4d35b902013-08-24 07:25:21 +00007 if (HAVE_DOT)
8 set(DOT ${LLVM_PATH_DOT})
9 endif()
Michael Gottesman7ed90882013-08-28 20:28:35 +000010
Michael Gottesman406525d2013-08-28 21:55:26 +000011 if (LLVM_DOXYGEN_EXTERNAL_SEARCH)
12 set(enable_searchengine "YES")
13 set(searchengine_url "${LLVM_DOXYGEN_SEARCHENGINE_URL}")
14 set(enable_server_based_search "YES")
15 set(enable_external_search "YES")
16 set(extra_search_mappings "${LLVM_DOXYGEN_SEARCH_MAPPINGS}")
Michael Gottesman7ed90882013-08-28 20:28:35 +000017 else()
Michael Gottesman406525d2013-08-28 21:55:26 +000018 set(enable_searchengine "NO")
19 set(searchengine_url "")
20 set(enable_server_based_search "NO")
21 set(enable_external_search "NO")
22 set(extra_search_mappings "")
Michael Gottesman7ed90882013-08-28 20:28:35 +000023 endif()
Jonas Devlieghere0203ac92017-11-02 17:12:34 +000024
Michael Gottesman700a9912014-03-07 19:19:28 +000025 # If asked, configure doxygen for the creation of a Qt Compressed Help file.
26 option(LLVM_ENABLE_DOXYGEN_QT_HELP
27 "Generate a Qt Compressed Help file." OFF)
28 if (LLVM_ENABLE_DOXYGEN_QT_HELP)
29 set(LLVM_DOXYGEN_QCH_FILENAME "org.llvm.qch" CACHE STRING
30 "Filename of the Qt Compressed help file")
Jonas Devlieghere0203ac92017-11-02 17:12:34 +000031 set(LLVM_DOXYGEN_QHP_NAMESPACE "org.llvm" CACHE STRING
Michael Gottesman700a9912014-03-07 19:19:28 +000032 "Namespace under which the intermediate Qt Help Project file lives")
33 set(LLVM_DOXYGEN_QHP_CUST_FILTER_NAME "${PACKAGE_STRING}" CACHE STRING
34 "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-filters")
35 set(LLVM_DOXYGEN_QHP_CUST_FILTER_ATTRS "${PACKAGE_NAME},${PACKAGE_VERSION}" CACHE STRING
36 "See http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes")
Jonas Devlieghere0203ac92017-11-02 17:12:34 +000037 find_program(LLVM_DOXYGEN_QHELPGENERATOR_PATH qhelpgenerator
Michael Gottesman700a9912014-03-07 19:19:28 +000038 DOC "Path to the qhelpgenerator binary")
39 if (NOT LLVM_DOXYGEN_QHELPGENERATOR_PATH)
40 message(FATAL_ERROR "Failed to find qhelpgenerator binary")
41 endif()
42
43 set(llvm_doxygen_generate_qhp "YES")
44 set(llvm_doxygen_qch_filename "${LLVM_DOXYGEN_QCH_FILENAME}")
45 set(llvm_doxygen_qhp_namespace "${LLVM_DOXYGEN_QHP_NAMESPACE}")
46 set(llvm_doxygen_qhelpgenerator_path "${LLVM_DOXYGEN_QHELPGENERATOR_PATH}")
47 set(llvm_doxygen_qhp_cust_filter_name "${LLVM_DOXYGEN_QHP_CUST_FILTER_NAME}")
48 set(llvm_doxygen_qhp_cust_filter_attrs "${LLVM_DOXYGEN_QHP_CUST_FILTER_ATTRS}")
49
50 else()
51 set(llvm_doxygen_generate_qhp "NO")
52 set(llvm_doxygen_qch_filename "")
53 set(llvm_doxygen_qhp_namespace "")
54 set(llvm_doxygen_qhelpgenerator_path "")
55 set(llvm_doxygen_qhp_cust_filter_name "")
56 set(llvm_doxygen_qhp_cust_filter_attrs "")
57 endif()
Jonas Devlieghere0203ac92017-11-02 17:12:34 +000058
Hans Wennborg76b2a3ee2015-08-17 23:24:17 +000059 option(LLVM_DOXYGEN_SVG
60 "Use svg instead of png files for doxygen graphs." OFF)
61 if (LLVM_DOXYGEN_SVG)
62 set(DOT_IMAGE_FORMAT "svg")
63 else()
64 set(DOT_IMAGE_FORMAT "png")
65 endif()
66
Michael Gottesman4d35b902013-08-24 07:25:21 +000067 configure_file(${CMAKE_CURRENT_SOURCE_DIR}/doxygen.cfg.in
68 ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg @ONLY)
Michael Gottesman406525d2013-08-28 21:55:26 +000069
Michael Gottesman4d35b902013-08-24 07:25:21 +000070 set(abs_top_srcdir)
71 set(abs_top_builddir)
72 set(DOT)
Michael Gottesman406525d2013-08-28 21:55:26 +000073 set(enable_searchengine)
74 set(searchengine_url)
75 set(enable_server_based_search)
76 set(enable_external_search)
77 set(extra_search_mappings)
Michael Gottesman700a9912014-03-07 19:19:28 +000078 set(llvm_doxygen_generate_qhp)
79 set(llvm_doxygen_qch_filename)
80 set(llvm_doxygen_qhp_namespace)
81 set(llvm_doxygen_qhelpgenerator_path)
82 set(llvm_doxygen_qhp_cust_filter_name)
83 set(llvm_doxygen_qhp_cust_filter_attrs)
Hans Wennborg76b2a3ee2015-08-17 23:24:17 +000084 set(DOT_IMAGE_FORMAT)
Michael Gottesman4d35b902013-08-24 07:25:21 +000085
Michael Gottesman9cc5a452013-08-28 20:28:32 +000086 add_custom_target(doxygen-llvm
Michael Gottesman4d35b902013-08-24 07:25:21 +000087 COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxygen.cfg
88 WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
Michael Gottesman9cc5a452013-08-28 20:28:32 +000089 COMMENT "Generating llvm doxygen documentation." VERBATIM)
Michael Kruse4ecbfac2024-05-25 13:28:30 +020090 set_target_properties(doxygen-llvm PROPERTIES FOLDER "LLVM/Docs")
Michael Gottesman9cc5a452013-08-28 20:28:32 +000091
92 if (LLVM_BUILD_DOCS)
93 add_dependencies(doxygen doxygen-llvm)
94 endif()
Michael Gottesman4d35b902013-08-24 07:25:21 +000095
96 if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
Michal Gornyc496c502016-09-27 19:52:29 +000097 # ./ suffix is needed to copy the contents of html directory without
98 # appending html/ into LLVM_INSTALL_DOXYGEN_HTML_DIR.
99 install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/doxygen/html/.
100 COMPONENT doxygen-html
101 DESTINATION "${LLVM_INSTALL_DOXYGEN_HTML_DIR}")
Michael Gottesman4d35b902013-08-24 07:25:21 +0000102 endif()
103endif()
104endif()
Reid Kleckner9f5eb632014-04-18 21:45:25 +0000105
106if (LLVM_ENABLE_SPHINX)
Tom Stellardea139ec2017-05-09 01:41:28 +0000107 include(AddSphinxTarget)
Reid Kleckner9f5eb632014-04-18 21:45:25 +0000108 if (SPHINX_FOUND)
Reid Kleckner9f5eb632014-04-18 21:45:25 +0000109 if (${SPHINX_OUTPUT_HTML})
110 add_sphinx_target(html llvm)
111 endif()
112
113
114 if (${SPHINX_OUTPUT_MAN})
115 add_sphinx_target(man llvm)
Adrian Prantlf01b3f32017-10-03 23:46:57 +0000116 add_sphinx_target(man llvm-dwarfdump)
Jonas Devliegherefb7bf1d2017-11-02 18:44:54 +0000117 add_sphinx_target(man dsymutil)
Reid Kleckner9f5eb632014-04-18 21:45:25 +0000118 endif()
119
120 endif()
121endif()
Peter Zotovb20073c2014-12-01 19:50:23 +0000122
123list(FIND LLVM_BINDINGS_LIST ocaml uses_ocaml)
Peter Zotovb2a12752016-08-23 18:07:16 +0000124if( NOT uses_ocaml LESS 0 AND LLVM_ENABLE_OCAMLDOC )
Peter Zotovb20073c2014-12-01 19:50:23 +0000125 set(doc_targets
126 ocaml_llvm
127 ocaml_llvm_all_backends
128 ocaml_llvm_analysis
129 ocaml_llvm_bitreader
130 ocaml_llvm_bitwriter
131 ocaml_llvm_executionengine
132 ocaml_llvm_irreader
133 ocaml_llvm_linker
134 ocaml_llvm_target
Peter Zotov0d040f62014-12-01 19:50:39 +0000135 ocaml_llvm_transform_utils
Peter Zotovb20073c2014-12-01 19:50:23 +0000136 )
137
138 foreach(llvm_target ${LLVM_TARGETS_TO_BUILD})
139 list(APPEND doc_targets ocaml_llvm_${llvm_target})
140 endforeach()
141
142 set(odoc_files)
143 foreach( doc_target ${doc_targets} )
144 get_target_property(odoc_file ${doc_target} OCAML_ODOC)
145 list(APPEND odoc_files -load ${odoc_file})
146 endforeach()
147
148 add_custom_target(ocaml_doc
149 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html
150 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html
151 COMMAND ${OCAMLFIND} ocamldoc -d ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html
Peter Zotov7ef4bf52015-07-17 06:37:59 +0000152 -sort -colorize-code -html ${odoc_files}
153 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_CURRENT_SOURCE_DIR}/_ocamldoc/style.css
154 ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html)
Peter Zotovb20073c2014-12-01 19:50:23 +0000155
156 add_dependencies(ocaml_doc ${doc_targets})
157
158 if (NOT LLVM_INSTALL_TOOLCHAIN_ONLY)
Michal Gornyc496c502016-09-27 19:52:29 +0000159 # ./ suffix is needed to copy the contents of html directory without
160 # appending html/ into LLVM_INSTALL_OCAMLDOC_HTML_DIR.
161 install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/ocamldoc/html/.
162 COMPONENT ocamldoc-html
163 DESTINATION "${LLVM_INSTALL_OCAMLDOC_HTML_DIR}")
Peter Zotovb20073c2014-12-01 19:50:23 +0000164 endif()
165endif()