mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-25 04:02:41 +01:00
[clang][cmake] Include generated rst files in html built by docs-clang-html target
Summary: This is an attempt to simply the process of building the clang documentation, which should help avoid some of the recent issues we've had generating the documentation for the website. The html documentation for clang is generated by sphinx from the reStructuredText (rst) files we have in the clang/docs directory. There are also some rst files that need to be generated by TableGen, before they can be passed to sphinx. Prior to this patch we were not generating those rst files as part with the build system and they had to be generated manually. This patch enables the automatic generation of these rst files, but since they are generated at build time the cannot be placed in the clang/docs directory and must go into the cmake build directory. Unfortunately sphinx does not currently support multiple source directories[1], so in order to be able to generate the full documentation, we need to work around this by copying the rst files from the clang/docs into the build directory before generating the html documentation. [1] https://github.com/sphinx-doc/sphinx/issues/3132 Reviewers: rsmith, aaron.ballman, beanz, smeenai, phosek, compnerd, mgorny, delcypher Reviewed By: mgorny, delcypher Subscribers: delcypher, merge_guards_bot, mgorny, llvm-commits, cfe-commits Tags: #clang, #llvm Differential Revision: https://reviews.llvm.org/D72875
This commit is contained in:
parent
3469e7634a
commit
00be3f56b9
@ -18,6 +18,7 @@ endif()
|
||||
#
|
||||
# ``project`` should be the project name
|
||||
function (add_sphinx_target builder project)
|
||||
cmake_parse_arguments(ARG "" "SOURCE_DIR" "" ${ARGN})
|
||||
set(SPHINX_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/${builder}")
|
||||
set(SPHINX_DOC_TREE_DIR "${CMAKE_CURRENT_BINARY_DIR}/_doctrees-${project}-${builder}")
|
||||
set(SPHINX_TARGET_NAME docs-${project}-${builder})
|
||||
@ -28,13 +29,17 @@ function (add_sphinx_target builder project)
|
||||
set(SPHINX_WARNINGS_AS_ERRORS_FLAG "")
|
||||
endif()
|
||||
|
||||
if (NOT ARG_SOURCE_DIR)
|
||||
set(ARG_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
|
||||
endif()
|
||||
|
||||
add_custom_target(${SPHINX_TARGET_NAME}
|
||||
COMMAND ${SPHINX_EXECUTABLE}
|
||||
-b ${builder}
|
||||
-d "${SPHINX_DOC_TREE_DIR}"
|
||||
-q # Quiet: no output other than errors and warnings.
|
||||
${SPHINX_WARNINGS_AS_ERRORS_FLAG} # Treat warnings as errors if requested
|
||||
"${CMAKE_CURRENT_SOURCE_DIR}" # Source
|
||||
"${ARG_SOURCE_DIR}" # Source
|
||||
"${SPHINX_BUILD_DIR}" # Output
|
||||
COMMENT
|
||||
"Generating ${builder} Sphinx documentation for ${project} into \"${SPHINX_BUILD_DIR}\"")
|
||||
|
Loading…
Reference in New Issue
Block a user